Struct RecordCheckout 

pub struct RecordCheckout {
    pub id: RecordId,
    pub kind: RecordKind,
    pub references: Vec<(RecordCheckout, String)>,
    pub formerly: Vec<RecordId>,
}

A record named together with its type — what a widget declares it is working on, and what a room index holds.

Fields

id: RecordId

kind: RecordKind

references: Vec<(RecordCheckout, String)>

Records this one references, and what each means. Declared here (not written by the app) because a reference has two halves only the host can write: it goes into this record’s document, and the target is brought into the room index so it doesn’t dangle. One level deep.

formerly: Vec<RecordId>

Identities this record was known by before — a file record that used to be named by its path. When nothing is stored under Self::id, the host adopts the stored document of the first former identity that no other successor has claimed (see RecordCheckout::formerly).

Implementations

impl RecordCheckout

pub fn for_component_tab( app_id: &str, tab: u64, kind: RecordKind, ) -> RecordCheckout

The record a desktop tab of app_id shows: the room’s package-primary record for Chat, the tab’s own record for every other app. Keeps the tab identity, so a tab dragged elsewhere keeps its document.

pub fn package_primary(kind: RecordKind) -> RecordCheckout

pub fn new(id: RecordId, kind: RecordKind) -> RecordCheckout

pub fn formerly(self, former: RecordId) -> RecordCheckout

Declare that this record used to be former. Opening it where nothing is stored under the new id adopts the former record’s document — its content, history and actors — restamped with the new identity. Custody of the former document is claimed durably by the first successor, so a different record naming the same former id (another file that later sits at the same path) never adopts it too. The former document itself stays on disk untouched.

pub fn referencing( self, target: RecordCheckout, relation: impl Into<String>, ) -> RecordCheckout

pub fn is_valid(&self) -> bool

Room indexes contain names supplied by collaborators. Keep the transport boundary typed and bounded before a host considers one.

Trait Implementations

impl Clone for RecordCheckout

fn clone(&self) -> RecordCheckout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordCheckout

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

Formats the value using the given formatter.

impl Ord for RecordCheckout

fn cmp(&self, other: &RecordCheckout) -> 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.

impl PartialEq for RecordCheckout

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RecordCheckout

fn partial_cmp(&self, other: &RecordCheckout) -> 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 Eq for RecordCheckout

impl StructuralPartialEq for RecordCheckout