Skip to main content

Snapshot

Struct Snapshot 

Source
pub struct Snapshot { /* private fields */ }
Expand description

The IDs of one world, each with a fingerprint of its content.

Implementations§

Source§

impl Snapshot

Source

pub fn from_world(world: &World, limits: &Limits) -> Result<Self, Error>

The snapshot of a loaded source tree. The world is already in memory, so limits bound the snapshot built from it.

§Errors

Returns Error::TooManyIds if the world has more IDs than limits allow, or Error::Invalid if a document of the world cannot be read again, which a world that loaded never has.

Source

pub fn from_pack(pack: &Pack, limits: &Limits) -> Result<Self, Error>

The snapshot of a content pack. The pack is fully verified first, as Pack::verify does, and its IDs are then read through Pack::visit_identities one row at a time; reading stops as soon as the pack has more IDs than limits allow.

§Errors

Returns Error::TooManyIds past the limit, or Error::Pack if the pack does not verify or SQLite fails.

Source

pub const fn side(&self) -> &Side

Where the snapshot came from.

Source

pub fn contains(&self, kind: Kind, id: &str) -> bool

Whether the world has ID id of kind.

Source

pub fn object_plane(&self, uid: &str) -> Option<&str>

The plane the object with uid is on.

Source

pub fn ids(&self, kind: Kind) -> impl Iterator<Item = &str>

The IDs of kind, in byte order.

Trait Implementations§

Source§

impl Clone for Snapshot

Source§

fn clone(&self) -> Self

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 Snapshot

Source§

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

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

impl Eq for Snapshot

Source§

impl PartialEq for Snapshot

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Snapshot

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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.