Struct TraversalRequest

pub struct TraversalRequest {
    pub src: Vec<String>,
    pub direction: i32,
    pub edges: Option<String>,
    pub max_edges: Option<i64>,
    pub min_depth: Option<i64>,
    pub max_depth: Option<i64>,
    pub return_nodes: Option<NodeFilter>,
    pub mask: Option<FieldMask>,
    pub max_matching_nodes: Option<i64>,
}

TraversalRequest describes how a breadth-first traversal should be performed, and what should be returned to the client.

Fields

src: Vec<String>

Set of source nodes (SWHIDs)

direction: i32

Direction of the graph to traverse. Defaults to FORWARD.

edges: Option<String>

Edge restriction string (e.g. “rev:dir,dir:cnt”). Defaults to “*” (all).

max_edges: Option<i64>

Maximum number of edges accessed in the traversal, after which it stops. Defaults to infinite.

min_depth: Option<i64>

Do not return nodes with a depth lower than this number. By default, all depths are returned.

max_depth: Option<i64>

Maximum depth of the traversal, after which it stops. Defaults to infinite.

return_nodes: Option<NodeFilter>

Filter which nodes will be sent to the stream. By default, all nodes are returned.

mask: Option<FieldMask>

FieldMask of which fields are to be returned (e.g., “swhid,cnt.length”). By default, all fields are returned.

max_matching_nodes: Option<i64>

Maximum number of matching results before stopping. For Traverse(), this is the total number of results. Defaults to infinite.

Implementations

impl TraversalRequest

pub fn direction(&self) -> GraphDirection

Returns the enum value of direction, or the default if the field is set to an invalid enum value.

pub fn set_direction(&mut self, value: GraphDirection)

Sets direction to the provided enum value.

pub fn edges(&self) -> &str

Returns the value of edges, or the default value if edges is unset.

pub fn max_edges(&self) -> i64

Returns the value of max_edges, or the default value if max_edges is unset.

pub fn min_depth(&self) -> i64

Returns the value of min_depth, or the default value if min_depth is unset.

pub fn max_depth(&self) -> i64

Returns the value of max_depth, or the default value if max_depth is unset.

pub fn max_matching_nodes(&self) -> i64

Returns the value of max_matching_nodes, or the default value if max_matching_nodes is unset.

Trait Implementations

impl Clone for TraversalRequest

fn clone(&self) -> TraversalRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TraversalRequest

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

Formats the value using the given formatter.

impl Default for TraversalRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for TraversalRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TraversalRequest

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

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

const 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 StructuralPartialEq for TraversalRequest