Struct Options 

pub struct Options {
    pub client_id: u64,
    pub guid: Arc<str>,
    pub collection_id: Option<Arc<str>>,
    pub offset_kind: OffsetKind,
    pub skip_gc: bool,
    pub auto_load: bool,
    pub should_load: bool,
}

Configuration options of Doc instance.

Fields

client_id: u64

Globally unique client identifier. This value must be unique across all active collaborating peers, otherwise a update collisions will happen, causing document store state to be corrupted.

Default value: randomly generated.

guid: Arc<str>

A globally unique identifier for this document.

Default value: randomly generated UUID v4.

collection_id: Option<Arc<str>>

Associate this document with a collection. This only plays a role if your provider has a concept of collection.

Default value: None.

offset_kind: OffsetKind

How to we count offsets and lengths used in text operations.

Default value: OffsetKind::Bytes.

skip_gc: bool

Determines if transactions commits should try to perform GC-ing of deleted items.

Default value: false.

auto_load: bool

If a subdocument, automatically load document. If this is a subdocument, remote peers will load the document as well automatically.

Default value: false.

should_load: bool

Whether the document should be synced by the provider now. This is toggled to true when you call ydoc.load().

Default value: true.

Implementations

impl Options

pub fn with_client_id(client_id: u64) -> Options

pub fn with_guid_and_client_id(guid: Arc<str>, client_id: u64) -> Options

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Decode for Options

fn decode<D>(decoder: &mut D) -> Result<Options, Error>

where D: Decoder,

fn decode_v1(data: &[u8]) -> Result<Self, Error>

Helper function for decoding 1st version of lib0 encoding.

fn decode_v2(data: &[u8]) -> Result<Self, Error>

Helper function for decoding 2nd version of lib0 encoding.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl Encode for Options

fn encode<E>(&self, encoder: &mut E)

where E: Encoder,

fn encode_v1(&self) -> Vec<u8>

Helper function for encoding 1st version of lib0 encoding.

fn encode_v2(&self) -> Vec<u8>

Helper function for encoding 2nd version of lib0 encoding.

impl PartialEq for Options

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

impl StructuralPartialEq for Options