Struct Object 

pub struct Object(pub VecMap<Strand, Value>);

Invariant: Keys never contain NUL bytes.

• Rev 1 — u16 revision || VecMap<Strand, Value> (length-prefixed sorted entries). Byte-identical to the legacy on-disk encoding.
• Rev 2 — optimised envelope (u16 revision || u32_le payload_length), inner VecMap written via the indexed-map prologue past OFFSET_TABLE_MIN_LEN = 8. Walker descent stays zero-allocation: walk_field_0() on a Wire-repr parent borrows the field bytes directly by bracketing skip_indexed_map with BorrowedReader::remaining() snapshots, no decode + re-encode required.

Tuple Fields

0: VecMap<Strand, Value>

Implementations

impl Object

pub fn walk_revisioned_field_names( wire_revision: u16, ) -> &'static [&'static str]

Field names at the given wire revision in declaration order. Returns an empty slice if the revision is unknown. Generated by the revisioned derive.

impl Object

pub const REVISION: u16 = 2u16

The revision number of this type, as declared via #[revisioned(revision = N)].

impl Object

pub fn insert(&mut self, key: impl Into<Strand>, value: Value) -> Option<Value>

Insert a key-value pair into the object.

The key is accepted as anything convertible to Strand (including String, &str, and Strand), which keeps call sites ergonomic.

pub fn get(&self, key: &str) -> Option<&Value>

Look up a value by key.

Takes &str, so &String callers work transparently via deref coercion — avoiding the Borrow<String> trait bound that would otherwise be required on Strand.

pub fn get_mut(&mut self, key: &str) -> Option<&mut Value>

Look up a value by key for mutation.

pub fn contains_key(&self, key: &str) -> bool

Check whether the object contains a given key.

pub fn remove(&mut self, key: &str) -> Option<Value>

Remove and return the value for key.

pub fn entry( &mut self, key: impl Into<Strand>, ) -> VecMapEntry<'_, Strand, Value>

Return the map entry for key, so callers can use the Entry API without manual interning.

pub fn rid(&self) -> Option<RecordId>

Fetch the record id if there is one

pub fn into_literal(self) -> Vec<ObjectEntry>

Methods from Deref<Target = VecMap<Strand, Value>>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

pub fn get<Q>(&self, key: &Q) -> Option<&V>

where Q: Ord + ?Sized, K: Borrow<Q>,

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>

where Q: Ord + ?Sized, K: Borrow<Q>,

pub fn contains_key<Q>(&self, key: &Q) -> bool

where Q: Ord + ?Sized, K: Borrow<Q>,

pub fn insert(&mut self, key: K, value: V) -> Option<V>

where K: Ord,

pub fn remove<Q>(&mut self, key: &Q) -> Option<V>

where Q: Ord + ?Sized, K: Borrow<Q>,

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&K, &mut V) -> bool,

pub fn append(&mut self, other: &mut VecMap<K, V>)

where K: Ord,

Moves all elements from other into self, leaving other empty.

This matches BTreeMap::append: both maps must already be sorted by key with no duplicates within each map. If the same key appears in both, the value from other replaces the value in self (the key slot from self is dropped, as with BTreeMap::insert).

pub fn push(&mut self, key: K, value: V)

where K: Ord,

Appends (key, value) in O(1) amortized time without searching.

Ordering

key must be strictly greater than every existing key (or the map must be empty). Violating this breaks sorted-map invariants; it is checked with debug_assert! only (see append).

pub fn iter(&self) -> Iter<'_, K, V>

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

pub fn keys(&self) -> impl Iterator<Item = &K>

pub fn values(&self) -> impl Iterator<Item = &V>

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut V>

pub fn first_key_value(&self) -> Option<(&K, &V)>

pub fn last_key_value(&self) -> Option<(&K, &V)>

pub fn entry(&mut self, key: K) -> Entry<'_, K, V>

where K: Ord,

Trait Implementations

impl Add for Object

type Output = Object

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<'de> BorrowDecode<'de, IndexFormat> for Object

fn borrow_decode(_r: &mut BorrowReader<'de>) -> Result<Self, DecodeError>

impl<'de> BorrowDecode<'de> for Object

fn borrow_decode(_r: &mut BorrowReader<'de>) -> Result<Self, DecodeError>

impl Cast for Object

fn can_cast(v: &Value) -> bool

Returns true if calling cast on the value will succeed.

fn cast(v: Value) -> Result<Self, CastError>

Cast a value to the self type.

impl Clone for Object

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Coerce for Object

fn can_coerce(v: &Value) -> bool

Returns if calling coerce on the value will succeed or not.

fn coerce(v: Value) -> Result<Self, CoerceError>

Coerce a value.

impl Debug for Object

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Object

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Object

type Target = VecMap<Strand, Value>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Object

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DeserializeRevisioned for Object

fn deserialize_revisioned<R: Read>(reader: &mut R) -> Result<Self, Error>

Deserializes a new instance of the struct from the specified reader.

impl Encode for Object

fn encode<W: Write>(&self, _w: &mut Writer<W>) -> Result<(), EncodeError>

impl Encode<IndexFormat> for Object

fn encode<W: Write>(&self, _w: &mut Writer<W>) -> Result<(), EncodeError>

impl Eq for Object

impl From<BTreeMap<&str, Value>> for Object

fn from(v: BTreeMap<&str, Value>) -> Self

Converts to this type from the input type.

impl From<BTreeMap<Strand, Value>> for Object

fn from(v: BTreeMap<Strand, Value>) -> Self

Converts to this type from the input type.

impl From<BTreeMap<String, String>> for Object

fn from(v: BTreeMap<String, String>) -> Self

Converts to this type from the input type.

impl From<BTreeMap<String, Value>> for Object

fn from(v: BTreeMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<HashMap<&str, Value>> for Object

fn from(v: HashMap<&str, Value>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, Value>> for Object

fn from(v: HashMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<Object> for Variables

fn from(obj: Object) -> Self

Converts to this type from the input type.

impl From<Object> for Object

fn from(s: PublicObject) -> Self

Converts to this type from the input type.

impl From<Object> for RecordIdKey

fn from(value: Object) -> Self

Converts to this type from the input type.

impl From<Object> for Value

fn from(v: Object) -> Self

Converts to this type from the input type.

impl From<Vec<(String, Value)>> for Object

fn from(v: Vec<(String, Value)>) -> Self

Converts to this type from the input type.

impl From<VecMap<&str, Value>> for Object

fn from(v: VecMap<&str, Value>) -> Self

Converts to this type from the input type.

impl From<VecMap<Strand, Value>> for Object

fn from(v: VecMap<Strand, Value>) -> Self

Converts to this type from the input type.

impl From<VecMap<String, Value>> for Object

fn from(v: VecMap<String, Value>) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<(&'a str, Value)> for Object

fn from_iter<T: IntoIterator<Item = (&'a str, Value)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(Strand, Value)> for Object

fn from_iter<T: IntoIterator<Item = (Strand, Value)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(String, Value)> for Object

fn from_iter<T: IntoIterator<Item = (String, Value)>>(iter: T) -> Self

Creates a value from an iterator.

impl HasKind for Object

fn kind() -> Kind

impl Hash for Object

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Object

type Item = (Strand, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<Strand, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Object

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Object

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Object

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Revisioned for Object

fn revision() -> u16

Returns the current revision of this type.

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

impl SerializeRevisioned for Object

fn serialize_revisioned<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Serializes the struct using the specified writer.

impl SkipCheckRevisioned for Object

fn skip_check_revisioned<R: Read>(reader: &mut R) -> Result<(), Error>

impl SkipRevisioned for Object

fn skip_revisioned<R: Read>(reader: &mut R) -> Result<(), Error>

fn skip_revisioned_slice(reader: &mut SliceReader<'_>) -> Result<(), Error>

Consume through bytes backed by SliceReader without allocating a buffer for bulk segments.

impl StructuralPartialEq for Object

impl ToSql for Object

fn fmt_sql(&self, f: &mut String, sql_fmt: SqlFormat)

Format the type to a SQL string.

fn to_sql(&self) -> String

Convert the type to a SQL string.

fn to_sql_pretty(&self) -> String

Convert the type to a pretty-printed SQL string with indentation.

impl TryFrom<Object> for PublicObject

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<BTreeMap<String, String>> for Object

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<BTreeMap<String, String>, Self::Error>

Performs the conversion.

impl TryInto<HeaderMap> for Object

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<HeaderMap, Self::Error>

Performs the conversion.

impl WalkRevisioned for Object

type Walker<'r, R: BorrowedReader + 'r> = ObjectWalker<'r, R>

Walker produced by walk_revisioned.

fn walk_revisioned<'r, R: BorrowedReader>( reader: &'r mut R, ) -> Result<Self::Walker<'r, R>, Error>

Read the type’s revision-level prefix and return a walker positioned at the start of the body.