Struct Doc

pub struct Doc {
    pub owner: UserId,
    pub data: Blob,
    pub description: Option<String>,
    pub created_at: Timestamp,
    pub updated_at: Timestamp,
    pub version: Option<Version>,
}

Represents a document in a collection’s store.

This struct defines the structure of a document stored in a collection. It includes the following fields:

• owner: The UserId representing the owner of the document.
• data: A Blob containing the document’s data.
• description: An optional String providing additional document description, limited to 1024 characters.
• created_at: A u64 timestamp for the document’s creation.
• updated_at: A u64 timestamp for the document’s last update.
• version: A u64 number for the document’s version. The field is optional for backwards compatibility but, will be populated to 1 on the first create or update.

This struct is used to store and manage documents within a collection’s store.

Fields

owner: UserId

data: Blob

description: Option<String>

created_at: Timestamp

updated_at: Timestamp

version: Option<Version>

Implementations

impl Doc

pub fn prepare( caller: Principal, current_doc: &Option<Doc>, user_doc: SetDoc, ) -> Self

Trait Implementations

impl CandidType for Doc

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for Doc

fn clone(&self) -> Doc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Doc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Doc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Storable for Doc

const BOUND: Bound = Bound::Unbounded

The size bounds of the type.

fn to_bytes(&self) -> Cow<'_, [u8]>

Converts an element into bytes.

fn from_bytes(bytes: Cow<'_, [u8]>) -> Self

Converts bytes into an element.

fn to_bytes_checked(&self) -> Cow<'_, [u8]>

Like to_bytes, but includes additional checks to ensure the element’s serialized bytes are within the element’s bounds.

impl Timestamped for Doc

fn created_at(&self) -> Timestamp

fn updated_at(&self) -> Timestamp

fn cmp_updated_at(&self, other: &Self) -> Ordering

fn cmp_created_at(&self, other: &Self) -> Ordering