Enum VertexSelector 

pub enum VertexSelector<'a> {
    All,
    None,
    Single(igraph_int_t),
    List(Cow<'a, [igraph_int_t]>),
    Range(igraph_int_t, igraph_int_t),
    Adjacent {
        vertex: igraph_int_t,
        mode: NeighborMode,
    },
    NonAdjacent {
        vertex: igraph_int_t,
        mode: NeighborMode,
    },
}

A set of vertices, see the module docs.

Variants

All

All vertices, in increasing id order.

None

No vertex.

Single(igraph_int_t)

A single vertex.

List(Cow<'a, [igraph_int_t]>)

The listed vertices, in the given order (duplicates allowed).

Range(igraph_int_t, igraph_int_t)

Vertices with id in start..end; like a Rust range it is empty (and selects nothing, whatever the graph) when start >= end.

Adjacent

Neighbors of a vertex, each listed once, in increasing order (loops and multi-edges are ignored; see Graph::adjacent_vertices for other conventions).

Fields

vertex: igraph_int_t

The center vertex.

mode: NeighborMode

Which neighbors, for directed graphs.

NonAdjacent

Vertices not adjacent to a vertex.

Fields

vertex: igraph_int_t

The center vertex.

mode: NeighborMode

Which neighbors, for directed graphs.

Implementations

impl<'a> VertexSelector<'a>

pub fn adjacent(vertex: igraph_int_t, mode: NeighborMode) -> Self

The neighbors of vertex (shorthand for VertexSelector::Adjacent).

pub fn non_adjacent(vertex: igraph_int_t, mode: NeighborMode) -> Self

The vertices not adjacent to vertex (shorthand for VertexSelector::NonAdjacent).

pub fn into_owned(self) -> VertexSelector<'static>

An owned copy of the selector, not borrowing anything.

impl VertexSelector<'_>

pub fn to_raw(&self) -> Result<RawVs>

Builds the raw igraph selector (igraph_vs_t), for calling raw FFI functions; the safe wrappers of the crate do it for you.

Empty ranges (start >= end) become igraph_vs_none: igraph 1.0.0 and 1.0.1 would reject an empty range starting at vcount and accept a decreasing one with a negative size.

Errors

Only if igraph fails to build the selector (e.g. out of memory); vertex ids are validated when the selector is used.

Trait Implementations

impl<'a> Clone for VertexSelector<'a>

fn clone(&self) -> VertexSelector<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for VertexSelector<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for VertexSelector<'a>

impl<'a> From<&'a Vec<i64>> for VertexSelector<'a>

fn from(v: &'a Vec<igraph_int_t>) -> Self

Converts to this type from the input type.

impl<'a, const N: usize> From<&'a [i64; N]> for VertexSelector<'a>

fn from(v: &'a [igraph_int_t; N]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a [i64]> for VertexSelector<'a>

fn from(v: &'a [igraph_int_t]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a igraph_vector_int_t> for VertexSelector<'a>

fn from(v: &'a VectorInt) -> Self

Converts to this type from the input type.

impl From<Range<i64>> for VertexSelector<'_>

fn from(r: Range<igraph_int_t>) -> Self

Converts to this type from the input type.

impl From<RangeFull> for VertexSelector<'_>

fn from(_: RangeFull) -> Self

Converts to this type from the input type.

impl From<RangeInclusive<i64>> for VertexSelector<'_>

fn from(r: RangeInclusive<igraph_int_t>) -> Self

a..=b selects the vertices a, a + 1, ..., b (none if a > b).

impl From<Vec<i64>> for VertexSelector<'_>

fn from(v: Vec<igraph_int_t>) -> Self

Converts to this type from the input type.

impl From<i64> for VertexSelector<'_>

fn from(v: igraph_int_t) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for VertexSelector<'a>

fn eq(&self, other: &VertexSelector<'a>) -> 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<'a> StructuralPartialEq for VertexSelector<'a>