Struct StringArray 

pub struct StringArray { /* private fields */ }

A string array structure used by libgit2

Some APIs return arrays of strings which originate from libgit2. This wrapper type behaves a little like Vec<&str> but does so without copying the underlying strings until necessary.

Implementations

impl StringArray

pub fn get(&self, i: usize) -> Result<Option<&str>, Error>

Returns Ok(None) if i is out of bounds.

pub fn get_bytes(&self, i: usize) -> Option<&[u8]>

Returns None if i is out of bounds.

pub fn iter(&self) -> Iter<'_>

Returns an iterator over the strings contained within this array.

The iterator yields Option<&str> as it is unknown whether the contents are utf-8 or not.

pub fn iter_bytes(&self) -> IterBytes<'_>

Returns an iterator over the strings contained within this array, yielding byte slices.

pub fn len(&self) -> usize

Returns the number of strings in this array.

pub fn is_empty(&self) -> bool

Return true if this array is empty.

Trait Implementations

impl Binding for StringArray

type Raw = git_strarray

The raw type that allows you to interact with libgit2-sys.

unsafe fn from_raw(raw: git_strarray) -> StringArray

Build a git2 struct from its Binding::Raw value.

fn raw(&self) -> git_strarray

Access the Binding::Raw value for a struct.

unsafe fn from_raw_opt<T>(raw: T) -> Option<Self>

where T: Copy + IsNull, Self: Binding<Raw = T>,

A null-handling version of Binding::from_raw.

impl Drop for StringArray

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<'a> IntoIterator for &'a StringArray

type Item = Result<Option<&'a str>, Error>

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.