Struct FindPathToRequest

pub struct FindPathToRequest {
    pub src: Vec<String>,
    pub target: Option<NodeFilter>,
    pub direction: i32,
    pub edges: Option<String>,
    pub max_edges: Option<i64>,
    pub max_depth: Option<i64>,
    pub mask: Option<FieldMask>,
}

FindPathToRequest describes a request to find a shortest path between a set of nodes and a given target criteria, as well as what should be returned in the path.

Fields

src: Vec<String>

Set of source nodes (SWHIDs)

target: Option<NodeFilter>

Target criteria, i.e., what constitutes a valid path destination.

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.

max_depth: Option<i64>

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

mask: Option<FieldMask>

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

Implementations

impl FindPathToRequest

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 max_depth(&self) -> i64

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

Trait Implementations

impl Clone for FindPathToRequest

fn clone(&self) -> FindPathToRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FindPathToRequest

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

Formats the value using the given formatter.

impl Default for FindPathToRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for FindPathToRequest

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 FindPathToRequest

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