Implement Proxied for Maps

This change implements the Proxied trait for the Map type.

It leaves a TODO to implement SettableValue. I haven't implemented SettableValue yet because I have not yet been able to verify that we get the right copy_from semantics for both kernels. I'll implement set_on in a follow up.

PiperOrigin-RevId: 584285061
pull/14810/head
Jakob Buchgraber 1 year ago committed by Copybara-Service
parent 08d8b80b22
commit 95073f8e78
  1. 8
      rust/cpp.rs
  2. 144
      rust/map.rs
  3. 9
      rust/upb.rs

@ -8,6 +8,7 @@
// Rust Protobuf runtime using the C++ kernel. // Rust Protobuf runtime using the C++ kernel.
use crate::__internal::{Private, RawArena, RawMap, RawMessage, RawRepeatedField}; use crate::__internal::{Private, RawArena, RawMap, RawMessage, RawRepeatedField};
use core::fmt::Debug;
use paste::paste; use paste::paste;
use std::alloc::Layout; use std::alloc::Layout;
use std::cell::UnsafeCell; use std::cell::UnsafeCell;
@ -390,7 +391,7 @@ macro_rules! impl_scalar_map_values {
macro_rules! impl_scalar_maps { macro_rules! impl_scalar_maps {
($($t:ty),*) => { ($($t:ty),*) => {
paste! { $( paste! { $(
pub trait [< MapWith $t:camel KeyOps >] { pub trait [< MapWith $t:camel KeyOps >] : Sync + Send + Copy + Clone + Debug {
fn new_map() -> RawMap; fn new_map() -> RawMap;
fn clear(m: RawMap); fn clear(m: RawMap);
fn size(m: RawMap) -> usize; fn size(m: RawMap) -> usize;
@ -445,6 +446,11 @@ macro_rules! impl_scalar_maps {
impl_scalar_maps!(i32, u32, bool, u64, i64); impl_scalar_maps!(i32, u32, bool, u64, i64);
#[cfg(test)]
pub(crate) fn new_map_inner() -> MapInner<'static, i32, i64> {
Default::default()
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;

@ -6,6 +6,7 @@
// https://developers.google.com/open-source/licenses/bsd // https://developers.google.com/open-source/licenses/bsd
use crate::{ use crate::{
Mut, MutProxy, Proxied, SettableValue, View, ViewProxy,
__internal::Private, __internal::Private,
__runtime::{ __runtime::{
MapInner, MapWithBoolKeyOps, MapWithI32KeyOps, MapWithI64KeyOps, MapWithU32KeyOps, MapInner, MapWithBoolKeyOps, MapWithI32KeyOps, MapWithI64KeyOps, MapWithU32KeyOps,
@ -13,6 +14,7 @@ use crate::{
}, },
}; };
use paste::paste; use paste::paste;
use std::marker::PhantomData;
#[derive(Clone, Copy)] #[derive(Clone, Copy)]
#[repr(transparent)] #[repr(transparent)]
@ -20,29 +22,109 @@ pub struct MapView<'a, K: ?Sized, V: ?Sized> {
inner: MapInner<'a, K, V>, inner: MapInner<'a, K, V>,
} }
#[derive(Clone, Copy)] impl<'a, K: ?Sized, V: ?Sized> MapView<'a, K, V> {
pub fn from_inner(_private: Private, inner: MapInner<'a, K, V>) -> Self {
Self { inner }
}
}
unsafe impl<'a, K: ?Sized, V: ?Sized> Sync for MapView<'a, K, V> {}
unsafe impl<'a, K: ?Sized, V: ?Sized> Send for MapView<'a, K, V> {}
impl<'a, K: ?Sized, V: ?Sized> std::fmt::Debug for MapView<'a, K, V> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_tuple("MapView")
.field(&std::any::type_name::<K>())
.field(&std::any::type_name::<V>())
.finish()
}
}
#[derive(Debug)]
#[repr(transparent)] #[repr(transparent)]
pub struct MapMut<'a, K: ?Sized, V: ?Sized> { pub struct MapMut<'a, K: ?Sized, V: ?Sized> {
inner: MapInner<'a, K, V>, inner: MapInner<'a, K, V>,
} }
impl<'a, K: ?Sized, V: ?Sized> MapView<'a, K, V> { impl<'a, K: ?Sized, V: ?Sized> MapMut<'a, K, V> {
pub fn from_inner(_private: Private, inner: MapInner<'a, K, V>) -> Self { pub fn from_inner(_private: Private, inner: MapInner<'a, K, V>) -> Self {
Self { inner } Self { inner }
} }
} }
impl<'a, K: ?Sized, V: ?Sized> MapMut<'a, K, V> { unsafe impl<'a, K: ?Sized, V: ?Sized> Sync for MapMut<'a, K, V> {}
pub fn from_inner(_private: Private, inner: MapInner<'a, K, V>) -> Self {
Self { inner } impl<'a, K: ?Sized, V: ?Sized> std::ops::Deref for MapMut<'a, K, V> {
type Target = MapView<'a, K, V>;
fn deref(&self) -> &Self::Target {
// SAFETY:
// - `Map{View,Mut}<'a, T>` are both `#[repr(transparent)]` over `MapInner<'a,
// T>`.
// - `MapInner` is a type alias for `NonNull`.
unsafe { &*(self as *const Self as *const MapView<'a, K, V>) }
} }
} }
// This is a ZST type so we can implement `Proxied`. Users will work with
// `MapView` (`View<'_, Map>>) and `MapMut` (Mut<'_, Map>).
pub struct Map<K: ?Sized, V: ?Sized>(PhantomData<K>, PhantomData<V>);
macro_rules! impl_scalar_map_keys { macro_rules! impl_scalar_map_keys {
($(key_type $type:ty;)*) => { ($(key_type $t:ty;)*) => {
paste! { $( paste! { $(
impl<'a, V: [< MapWith $type:camel KeyOps >]> MapView<'a, $type, V> { impl<V: [< MapWith $t:camel KeyOps >]> Proxied for Map<$t, V>{
pub fn get(&self, key: $type) -> Option<V> { type View<'a> = MapView<'a, $t, V> where V: 'a;
type Mut<'a> = MapMut<'a, $t, V> where V: 'a;
}
impl<'a, V: [< MapWith $t:camel KeyOps >]> SettableValue<Map<$t, V>> for MapView<'a, $t, V> {
fn set_on(self, _private: Private, mut mutator: Mut<'_, Map<$t, V>>) {
mutator.copy_from(self);
}
}
impl<'a, V: [< MapWith $t:camel KeyOps >]> ViewProxy<'a> for MapView<'a, $t, V> {
type Proxied = Map<$t, V>;
fn as_view(&self) -> View<'_, Self::Proxied> {
*self
}
fn into_view<'shorter>(self) -> View<'shorter, Self::Proxied>
where 'a: 'shorter,
{
MapView { inner: self.inner }
}
}
impl<'a, V: [< MapWith $t:camel KeyOps >]> ViewProxy<'a> for MapMut<'a, $t, V> {
type Proxied = Map<$t, V>;
fn as_view(&self) -> View<'_, Self::Proxied> {
**self
}
fn into_view<'shorter>(self) -> View<'shorter, Self::Proxied>
where 'a: 'shorter,
{
*self.into_mut::<'shorter>()
}
}
impl<'a, V: [< MapWith $t:camel KeyOps >]> MutProxy<'a> for MapMut<'a, $t, V> {
fn as_mut(&mut self) -> Mut<'_, Self::Proxied> {
MapMut { inner: self.inner }
}
fn into_mut<'shorter>(self) -> Mut<'shorter, Self::Proxied>
where 'a: 'shorter,
{
MapMut { inner: self.inner }
}
}
impl<'a, V: [< MapWith $t:camel KeyOps >]> MapView<'a, $t, V> {
pub fn get(&self, key: $t) -> Option<V> {
self.inner.get(key) self.inner.get(key)
} }
@ -55,18 +137,22 @@ macro_rules! impl_scalar_map_keys {
} }
} }
impl<'a, V: [< MapWith $type:camel KeyOps >]> MapMut<'a, $type, V> { impl<'a, V: [< MapWith $t:camel KeyOps >]> MapMut<'a, $t, V> {
pub fn insert(&mut self, key: $type, value: V) -> bool { pub fn insert(&mut self, key: $t, value: V) -> bool {
self.inner.insert(key, value) self.inner.insert(key, value)
} }
pub fn remove(&mut self, key: $type) -> Option<V> { pub fn remove(&mut self, key: $t) -> Option<V> {
self.inner.remove(key) self.inner.remove(key)
} }
pub fn clear(&mut self) { pub fn clear(&mut self) {
self.inner.clear() self.inner.clear()
} }
pub fn copy_from(&mut self, _src: MapView<'_, $t, V>) {
todo!("implement b/28530933");
}
} }
)* } )* }
}; };
@ -79,3 +165,39 @@ impl_scalar_map_keys!(
key_type u64; key_type u64;
key_type bool; key_type bool;
); );
#[cfg(test)]
mod tests {
use super::*;
use crate::__runtime::new_map_inner;
use googletest::prelude::*;
#[test]
fn test_proxied() {
let mut map_mut = MapMut::from_inner(Private, new_map_inner());
map_mut.insert(1, 2);
let map_view_1 = map_mut.as_view();
assert_that!(map_view_1.len(), eq(1));
assert_that!(map_view_1.get(1), eq(Some(2)));
map_mut.insert(3, 4);
let map_view_2 = map_mut.into_view();
assert_that!(map_view_2.len(), eq(2));
assert_that!(map_view_2.get(3), eq(Some(4)));
{
let map_view_3 = map_view_2.as_view();
assert_that!(map_view_3.is_empty(), eq(false));
}
let map_view_4 = map_view_2.into_view();
assert_that!(map_view_4.is_empty(), eq(false));
}
#[test]
fn test_dbg() {
let mut map_view = MapView::from_inner(Private, new_map_inner());
assert_that!(format!("{:?}", map_view), eq("MapView(\"i32\", \"i64\")"));
}
}

@ -8,6 +8,7 @@
//! UPB FFI wrapper code for use by Rust Protobuf. //! UPB FFI wrapper code for use by Rust Protobuf.
use crate::__internal::{Private, PtrAndLen, RawArena, RawMap, RawMessage, RawRepeatedField}; use crate::__internal::{Private, PtrAndLen, RawArena, RawMap, RawMessage, RawRepeatedField};
use core::fmt::Debug;
use paste::paste; use paste::paste;
use std::alloc; use std::alloc;
use std::alloc::Layout; use std::alloc::Layout;
@ -567,7 +568,7 @@ macro_rules! impl_scalar_map_for_key_type {
macro_rules! impl_scalar_map_for_key_types { macro_rules! impl_scalar_map_for_key_types {
($($t:ty, $ufield:ident, $upb_tag:expr;)*) => { ($($t:ty, $ufield:ident, $upb_tag:expr;)*) => {
paste! { $( paste! { $(
pub trait [< MapWith $t:camel KeyOps >] { pub trait [< MapWith $t:camel KeyOps >] : Sync + Send + Copy + Clone + Debug {
fn new_map(a: RawArena) -> RawMap; fn new_map(a: RawArena) -> RawMap;
fn clear(m: RawMap); fn clear(m: RawMap);
fn size(m: RawMap) -> usize; fn size(m: RawMap) -> usize;
@ -650,6 +651,12 @@ extern "C" {
fn upb_Map_Clear(map: RawMap); fn upb_Map_Clear(map: RawMap);
} }
#[cfg(test)]
pub(crate) fn new_map_inner() -> MapInner<'static, i32, i64> {
let arena = Box::leak::<'static>(Box::new(Arena::new()));
MapInner::<'static, i32, i64>::new(arena)
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;

Loading…
Cancel
Save