Struct UrlDocumentInfo

#[non_exhaustive]
pub struct UrlDocumentInfo {
    pub access_type: AccessType,
    pub encrypted: Option<bool>,
    pub static_info: StaticDocumentInfo,
    pub dynamic_info: Option<DynamicDocumentInfo>,
}

Document information parsed from a document URL. NB: This is a limited set of information compared to what is received when manipulating documents in a live peermerge, i.e. DocumentInfo. Most notably, the URL will not contain a full list of child documents because that list can grow infinitely and thus cause the URL to exceed the maximum character limit.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

access_type: AccessType

Access to the document

encrypted: Option<bool>

Is the document encrypted. For access_type Proxy, this is None.

static_info: StaticDocumentInfo

Static information about the document that’s always available regardless of access_type.

dynamic_info: Option<DynamicDocumentInfo>

Dynamic information about the document. This changes over time, and is None for access_type Proxy, and might contain outdated information for

Implementations

impl UrlDocumentInfo

pub fn id(&self) -> DocumentId

Convenience function for getting the document ID

Trait Implementations

impl Clone for UrlDocumentInfo

fn clone(&self) -> UrlDocumentInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UrlDocumentInfo

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

Formats the value using the given formatter.