Struct DocInfo 

pub struct DocInfo {
    pub name: Text,
    pub type_name: DocumentType,
    pub theory: Option<String>,
    pub permissions: Vec<PermissionInfo>,
    pub created_at: DateTime<Utc>,
    pub deleted_at: Option<DateTime<Utc>>,
    pub current_snapshot_updated_at: DateTime<Utc>,
    pub current_snapshot: i32,
    pub snapshots: HashMap<String, SnapshotInfo>,
    pub depends_on: Vec<RelationInfo>,
    pub used_by: Vec<RelationInfo>,
}

Document reference information for user state synchronization.

Contains lightweight metadata about a document that the user has access to.

Fields

name: Text

The name of the document.

type_name: DocumentType

The type of the document.

theory: Option<String>

The theory of the document, if it is a model.

permissions: Vec<PermissionInfo>

All permissions on this document (users and public).

created_at: DateTime<Utc>

When this document was created.

deleted_at: Option<DateTime<Utc>>

When this document was deleted, if applicable.

current_snapshot_updated_at: DateTime<Utc>

When the current snapshot pointer was last changed (snapshot created or undo/redo).

current_snapshot: i32

The database ID of the current (active) snapshot.

snapshots: HashMap<String, SnapshotInfo>

All snapshots for this document, keyed by stringified snapshot ID.

depends_on: Vec<RelationInfo>

Outgoing relations from this document to other documents.

used_by: Vec<RelationInfo>

Reverse relations: other documents that depend on this one.

Computed from depends_on across all documents. Each entry identifies the dependent document and the relation type.

Trait Implementations

impl Arbitrary for DocInfo

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<DocInfo>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for DocInfo

fn clone(&self) -> DocInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocInfo

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

Formats the value using the given formatter.

impl Hydrate for DocInfo

fn hydrate_map<D: ReadDoc>(doc: &D, obj: &ObjId) -> Result<Self, HydrateError>

fn hydrate<D>(doc: &D, obj: &ExId, prop: Prop<'_>) -> Result<Self, HydrateError>

where D: ReadDoc,

fn hydrate_scalar(s: Cow<'_, ScalarValue>) -> Result<Self, HydrateError>

fn hydrate_bool(_b: bool) -> Result<Self, HydrateError>

fn hydrate_bytes(_bytes: &[u8]) -> Result<Self, HydrateError>

fn hydrate_f64(_f: f64) -> Result<Self, HydrateError>

fn hydrate_counter(_c: i64) -> Result<Self, HydrateError>

fn hydrate_int(_i: i64) -> Result<Self, HydrateError>

fn hydrate_uint(_u: u64) -> Result<Self, HydrateError>

fn hydrate_string(_string: &str) -> Result<Self, HydrateError>

fn hydrate_timestamp(_t: i64) -> Result<Self, HydrateError>

fn hydrate_unknown(_type_code: u8, _bytes: &[u8]) -> Result<Self, HydrateError>

fn hydrate_seq<D>(_doc: &D, _obj: &ExId) -> Result<Self, HydrateError>

where D: ReadDoc,

fn hydrate_text<D>(_doc: &D, _obj: &ExId) -> Result<Self, HydrateError>

where D: ReadDoc,

fn hydrate_none() -> Result<Self, HydrateError>

impl PartialEq for DocInfo

fn eq(&self, other: &DocInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reconcile for DocInfo

type Key<'k> = NoKey

The type of the key of this item.

fn reconcile<__R123: Reconciler>( &self, reconciler: __R123, ) -> Result<(), __R123::Error>

Reconcile this item with the document

fn hydrate_key<'a, D>( doc: &D, obj: &ExId, prop: Prop<'_>, ) -> Result<LoadKey<Self::Key<'a>>, ReconcileError>

where D: ReadDoc,

Hydrate the key for this Object

fn key(&self) -> LoadKey<Self::Key<'_>>

Get the key from an instance of Self

impl TS for DocInfo

type WithoutGenerics = DocInfo

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = DocInfo

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use [TS::export_all].

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Eq for DocInfo

impl StructuralPartialEq for DocInfo