Struct Selector 

pub struct Selector {
    pub path: Option<String>,
    pub through: Option<String>,
    pub around: Option<u32>,
    pub offset: Option<u32>,
    pub limit: Option<u32>,
    pub mode: Option<ReadMode>,
    pub state: Option<ReadState>,
}

What to read. All fields are optional; an empty selector is an outline of the whole page or course.

Fields

path: Option<String>

A block or entity (/p1), a field (/p1/attributes/content, /ch3/deadline) or a children list (/box1/innerBlocks, /ch3/pages); "" is the page’s top level.

through: Option<String>

Last sibling (inclusive) of a range starting at path.

around: Option<u32>

Siblings to include on each side of path.

offset: Option<u32>

Start of a window over a children list.

limit: Option<u32>

Most items to return, from offset or from the block at path.

mode: Option<ReadMode>

state: Option<ReadState>

staged (default) includes changes waiting to be published; published is what students see.

Trait Implementations

impl Clone for Selector

fn clone(&self) -> Selector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Selector

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

Formats the value using the given formatter.

impl Default for Selector

fn default() -> Selector

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Selector

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Selector

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 Selector

fn eq(&self, other: &Selector) -> 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 Serialize for Selector

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 Selector