Skip to main content

EntryVisibility

Struct EntryVisibility 

Source
pub struct EntryVisibility {
    pub format_version: u8,
    pub change_id: ChangeId,
    pub tree_root: ContentHash,
    pub entries: Vec<EntryVisibilityEntry>,
}
Expand description

The per-state entry-visibility sidecar: the set of per-entry tier overrides covering the trees reachable from one state, keyed by that state’s ChangeId.

Fields§

§format_version: u8

Format version; Self::decode rejects anything but the current one.

§change_id: ChangeId

The state (by rewrite-stable change id) these overrides apply to.

§tree_root: ContentHash

The state’s root tree id — the anchor the entry records hang beneath.

§entries: Vec<EntryVisibilityEntry>

The per-entry overrides. Order is normalized (by (tree_id, leaf_hash)) so the encoded bytes are canonical for a given override set.

Implementations§

Source§

impl EntryVisibility

Source

pub fn new( change_id: ChangeId, tree_root: ContentHash, entries: Vec<EntryVisibilityEntry>, ) -> Result<EntryVisibility, EntryVisibilityError>

Build a sidecar from its overrides, normalizing entry order so equal override sets encode to identical bytes (and hash identically).

Fails loud on a conflicting duplicate: two overrides on the same (tree_id, leaf_hash) with different tiers. Leg 3 keys a serve-time map by leaf hash, so a duplicate leaf would be silent first/last-wins ambiguity. An exact duplicate (same leaf, same tier) is harmless and is de-duplicated.

Source

pub fn has_records(&self) -> bool

true iff this sidecar carries at least one override. An empty sidecar is never persisted (absence ≡ “every entry at the state baseline”).

Source

pub fn encode(&self) -> Result<Vec<u8>, EntryVisibilityError>

Encode to canonical msgpack bytes.

Source

pub fn decode(bytes: &[u8]) -> Result<EntryVisibility, EntryVisibilityError>

Decode msgpack bytes, rejecting an unsupported format version.

Source

pub fn content_hash(&self) -> Result<ContentHash, EntryVisibilityError>

Content-addressed id of this sidecar — blake3 over its canonical encoded bytes. Named in the oplog record so undo/redo can correlate.

Trait Implementations§

Source§

impl Clone for EntryVisibility

Source§

fn clone(&self) -> EntryVisibility

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EntryVisibility

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for EntryVisibility

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<EntryVisibility, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for EntryVisibility

Source§

impl PartialEq for EntryVisibility

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EntryVisibility

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EntryVisibility

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more