Struct DocumentCatalog 

pub struct DocumentCatalog {
    pub schema: CatalogSchema,
    pub total: u32,
    pub returned: u32,
    pub offset: u32,
    pub truncated: bool,
    pub next_offset: Option<u32>,
    pub documents: Vec<DocumentSummary>,
}

Deterministically ordered page of discoverable local documents.

Fields

schema: CatalogSchema

Exact response schema discriminator.

total: u32

Total rows matching the filters before pagination.

returned: u32

Number of rows present in Self::documents.

offset: u32

Applied zero-based result offset.

truncated: bool

Whether matching rows remain after this page.

next_offset: Option<u32>

Offset for the next page, when one exists.

documents: Vec<DocumentSummary>

Deterministically ordered page of document summaries.

Trait Implementations

impl Clone for DocumentCatalog

fn clone(&self) -> DocumentCatalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentCatalog

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentCatalog

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DocumentCatalog

impl JsonSchema for DocumentCatalog

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for DocumentCatalog

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocumentCatalog

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DocumentCatalog