Struct FindPathBetweenRequest

pub struct FindPathBetweenRequest {
    pub src: Vec<String>,
    pub dst: Vec<String>,
    pub direction: i32,
    pub direction_reverse: Option<i32>,
    pub edges: Option<String>,
    pub edges_reverse: 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 source nodes and a set of destination nodes. It works by performing a bidirectional breadth-first traversal from both sets at the same time.

Fields

src: Vec<String>

Set of source nodes (SWHIDs)

dst: Vec<String>

Set of destination nodes (SWHIDs)

direction: i32

Direction of the graph to traverse from the source set. Defaults to FORWARD.

direction_reverse: Option<i32>

Direction of the graph to traverse from the destination set. Defaults to the opposite of direction. If direction and direction_reverse are identical, it will find the first common successor of both sets in the given direction.

edges: Option<String>

Edge restriction string for the traversal from the source set. (e.g. “rev:dir,dir:cnt”). Defaults to “*” (all).

edges_reverse: Option<String>

Edge restriction string for the reverse traversal from the destination set. If not specified:

• If edges is not specified either, defaults to “*”
• If direction == direction_reverse, defaults to edges
• If direction != direction_reverse, defaults to the reverse of edges (e.g. “rev:dir” becomes “dir:rev”).

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 FindPathBetweenRequest

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 direction_reverse(&self) -> GraphDirection

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

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

Sets direction_reverse 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 edges_reverse(&self) -> &str

Returns the value of edges_reverse, or the default value if edges_reverse 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 FindPathBetweenRequest

fn clone(&self) -> FindPathBetweenRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FindPathBetweenRequest

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

Formats the value using the given formatter.

impl Default for FindPathBetweenRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for FindPathBetweenRequest

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 FindPathBetweenRequest

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