Struct yrs::YOptions

#[repr(C)]
pub struct YOptions {
    pub id: c_ulong,
    pub encoding: c_int,
    pub skip_gc: c_int,
}

Configuration object used by YDoc.

Fields

id: c_ulong

Globally unique 53-bit integer assigned to corresponding document replica as its identifier.

If two clients share the same id and will perform any updates, it will result in unrecoverable document state corruption. The same thing may happen if the client restored document state from snapshot, that didn’t contain all of that clients updates that were sent to other peers.

encoding: c_int

Encoding used by text editing operations on this document. It’s used to compute YText/YXmlText insertion offsets and text lengths. Either:

• Y_ENCODING_BYTES
• Y_ENCODING_UTF16
• Y_ENCODING_UTF32

skip_gc: c_int

Boolean flag used to determine if deleted blocks should be garbage collected or not during the transaction commits. Setting this value to 0 means GC will be performed.

Trait Implementations

impl Into<Options> for YOptions

fn into(self) -> Options

Converts this type into the (usually inferred) input type.