Struct CollectionDocument 

pub struct CollectionDocument {
    pub id: Option<Url>,
    pub ordered: bool,
    pub page: bool,
    pub total_items: Option<u64>,
    pub next: Option<Url>,
    pub prev: Option<Url>,
    pub part_of: Option<Url>,
    pub first: Option<Value>,
    pub last: Option<Value>,
    pub items: Option<Vec<Value>>,
}

An ActivityStreams collection or collection page, written as a document: what Ojak serves a Collection as, for an application that serves one itself, such as a collection paged by a query of its own or embedded in another object.

It is a page when it is part of a collection (part_of) or says it is (page), and ordered or not as ordered says. Its members are written whenever there are items, even none; a collection that only counts its members, or only links its pages, has None.

Fields

id: Option<Url>

Its id. An embedded page may have none.

ordered: bool

An OrderedCollection or OrderedCollectionPage, whose members are orderedItems, rather than a Collection or CollectionPage, whose members are items.

page: bool

A page, even with no part_of.

total_items: Option<u64>

Its totalItems.

next: Option<Url>

Its next page.

prev: Option<Url>

Its prev page.

part_of: Option<Url>

The collection it is a page of.

first: Option<Value>

Its first page: a URI, or the page embedded.

last: Option<Value>

Its last page: a URI, or the page embedded.

items: Option<Vec<Value>>

Its members, in order: IRIs as strings, or embedded objects.

Implementations

impl CollectionDocument

pub fn is_page(&self) -> bool

Whether it is a page rather than a collection.

pub fn type_name(&self) -> &'static str

Its type.

pub fn to_value(&self) -> Value

The document, without an @context: id, type, totalItems, next, prev, partOf, first, last and the members, in that order, each only when there is one.

Trait Implementations

impl Clone for CollectionDocument

fn clone(&self) -> CollectionDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionDocument

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

Formats the value using the given formatter.

impl Default for CollectionDocument

fn default() -> CollectionDocument

Returns the “default value” for a type.

impl PartialEq for CollectionDocument

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CollectionDocument