Type Alias igraph_strvector_t 

pub type igraph_strvector_t = s_igraph_strvector;

Aliased Type

pub struct igraph_strvector_t { /* private fields */ }

Implementations

impl igraph_strvector_t

pub fn new() -> Self

Creates an empty string vector (igraph_strvector_init).

pub fn len(&self) -> usize

Number of strings (igraph_strvector_size).

pub fn is_empty(&self) -> bool

Whether there are no strings.

pub fn get(&self, index: usize) -> Option<&str>

The string at index, or None if index is out of bounds or the string is not valid UTF-8 (use get_cstr, or the lossy iter and to_vec, for such strings) (igraph_strvector_get).

pub fn get_cstr(&self, index: usize) -> Option<&CStr>

The raw C string at index, if any, borrowed from the vector (igraph_strvector_get).

pub fn push(&mut self, value: &str)

Appends a copy of value (interior NUL bytes truncate it when read back) (igraph_strvector_push_back_len).

pub fn iter(&self) -> impl Iterator<Item = String> + '_

Iterates over the strings (lossily converted to UTF-8).

pub fn to_vec(&self) -> Vec<String>

Copies the strings into a Vec<String>.

impl igraph_strvector_t

pub fn with_len(len: usize) -> Self

Creates a vector of len empty strings (igraph_strvector_init).

pub fn set(&mut self, index: usize, value: &str) -> Result<()>

Replaces the string at index with a copy of value (igraph_strvector_set_len).

use igraph::prelude::*;
let mut names = StrVector::with_len(3);
names.set(1, "hub").unwrap();
assert_eq!(names.to_vec(), vec!["", "hub", ""]);
assert_eq!(&names[1], "hub");
assert!(names.set(3, "nope").is_err());

Errors

ErrorKind::InvalidValue if index is out of bounds.

pub fn remove(&mut self, index: usize) -> String

Removes the string at index and returns it (lossily converted to UTF-8) (igraph_strvector_remove).

Panics

If index is out of bounds.

pub fn pop(&mut self) -> Option<String>

Removes and returns the last string, if any.

pub fn remove_section(&mut self, range: Range<usize>)

Removes the strings in range (igraph_strvector_remove_section).

Panics

If the range goes past the end.

pub fn extend_from(&mut self, other: &Self)

Appends copies of all the strings of other (igraph_strvector_append).

pub fn append(&mut self, other: &mut Self)

Moves all the strings of other to the end of self, leaving other empty, without copying them, like Vec::append (igraph_strvector_merge).

pub fn resize(&mut self, len: usize)

Resizes to len strings: extra strings are dropped, new ones are empty (igraph_strvector_resize).

pub fn truncate(&mut self, len: usize)

Keeps only the first len strings (no-op if already shorter).

pub fn clear(&mut self)

Removes all strings (igraph_strvector_clear).

pub fn select(&self, index: &[igraph_int_t]) -> Result<Self>

A new vector with the strings at the given positions (repetitions allowed) (igraph_strvector_index, undocumented in igraph_strvector.h).

Errors

ErrorKind::InvalidValue if some position is out of bounds.

pub fn swap(&mut self, i: usize, j: usize)

Swaps the strings at i and j (igraph_strvector_swap_elements).

Panics

If an index is out of bounds.

pub fn capacity(&self) -> usize

Number of strings that fit without reallocating (igraph_strvector_capacity).

pub fn reserve(&mut self, capacity: usize)

Reserves room for at least capacity strings in total (igraph_strvector_reserve).

pub fn shrink_to_fit(&mut self)

Frees the unused storage (igraph_strvector_resize_min).

pub fn contains(&self, value: &str) -> bool

Whether some string equals value.

pub fn position(&self, value: &str) -> Option<usize>

Position of the first string equal to value, if any.

Trait Implementations

impl Clone for igraph_strvector_t

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for igraph_strvector_t

fn default() -> Self

Returns the “default value” for a type.

impl Display for igraph_strvector_t

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

Formats the value using the given formatter.

impl Drop for igraph_strvector_t

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<S: AsRef<str>> Extend<S> for igraph_strvector_t

fn extend<I: IntoIterator<Item = S>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<S: AsRef<str>> From<&[S]> for igraph_strvector_t

fn from(items: &[S]) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for igraph_strvector_t

fn from(items: Vec<String>) -> Self

Converts to this type from the input type.

impl<S: AsRef<str>> FromIterator<S> for igraph_strvector_t

fn from_iter<I: IntoIterator<Item = S>>(iter: I) -> Self

Creates a value from an iterator.

impl Index<usize> for igraph_strvector_t

fn index(&self, index: usize) -> &str

The string at index.

Panics

If index is out of bounds or the string is not valid UTF-8.

type Output = str

The returned type after indexing.

impl<'a> IntoIterator for &'a igraph_strvector_t

type Item = String

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = String> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for igraph_strvector_t

fn eq(&self, other: &Self) -> 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 PartialEq<[&str]> for igraph_strvector_t

fn eq(&self, other: &[&str]) -> 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 Send for igraph_strvector_t

impl Sync for igraph_strvector_t