Struct yrs::YBranchId

#[repr(C)]
pub struct YBranchId {
    pub client_or_len: i64,
    pub variant: YBranchIdVariant,
}

A structure representing logical identifier of a specific shared collection. Can be obtained by ybranch_id executed over alive Branch.

Use ybranch_get to resolve a Branch pointer from this branch ID.

This structure doesn’t need to be destroyed. It’s internal pointer reference is valid through a lifetime of a document, which collection this branch ID has been created from.

Fields

client_or_len: i64

If positive: Client ID of a creator of a nested shared type, this identifier points to. If negative: a negated Length of a root-level shared collection name.

variant: YBranchIdVariant