DocOptions

Struct DocOptions 

Source
pub struct DocOptions {
    pub guid: String,
    pub client_id: u64,
    pub gc: bool,
}
Expand description

DocOptions used to create a new Doc

use y_octo::DocOptions;

let doc = DocOptions::new()
    .with_client_id(1)
    .with_guid("guid".into())
    .auto_gc(true)
    .build();

assert_eq!(doc.guid(), "guid")

Fields§

§guid: String§client_id: u64§gc: bool

Implementations§

Source§

impl DocOptions

Source

pub fn new() -> Self

Source

pub fn with_client_id(self, client_id: u64) -> Self

Source

pub fn with_guid(self, guid: String) -> Self

Source

pub fn auto_gc(self, gc: bool) -> Self

Source

pub fn build(self) -> Doc

Trait Implementations§

Source§

impl Clone for DocOptions

Source§

fn clone(&self) -> DocOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocOptions

Source§

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

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

impl Default for DocOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<DocOptions> for Any

Source§

fn from(value: DocOptions) -> Self

Converts to this type from the input type.
Source§

impl TryFrom<Any> for DocOptions

Source§

type Error = JwstCodecError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Any) -> Result<Self, Self::Error>

Performs the conversion.

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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V