Struct DocumentTraversal 

pub struct DocumentTraversal {
    pub follow_links: bool,
    pub max_depth: Option<u16>,
    pub max_documents: Option<u32>,
}

Bounded traversal applied after resolving the initial documents.

Fields

follow_links: bool

Follow typed links to other registered documents.

max_depth: Option<u16>

Optional maximum number of link edges from an initial document.

Omission selects DEFAULT_SCOPE_DEPTH when Self::follow_links is true. The field is invalid when link traversal is disabled.

max_documents: Option<u32>

Optional maximum number of distinct documents, including roots.

Omission selects DEFAULT_SCOPE_DOCUMENT_LIMIT when Self::follow_links is true. The field is invalid when link traversal is disabled.

Implementations

impl DocumentTraversal

pub fn effective_max_depth(self) -> u16

Effective edge limit after applying the native default.

pub fn effective_max_documents(self) -> u32

Effective document budget after applying the native default.

Trait Implementations

impl Clone for DocumentTraversal

fn clone(&self) -> DocumentTraversal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DocumentTraversal

impl Debug for DocumentTraversal

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

Formats the value using the given formatter.

impl Default for DocumentTraversal

fn default() -> DocumentTraversal

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentTraversal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DocumentTraversal

impl JsonSchema for DocumentTraversal

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 DocumentTraversal

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocumentTraversal

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 DocumentTraversal