Struct safe_index::examples::clients::idx::Files

pub struct Files<T> { /* fields omitted */ }

Map from files to something.

Methods

impl<T> Files<T>

pub fn of(vec: Vec<T>) -> Self

Creates an empty map from an existing one.

pub fn new() -> Self

Creates an empty map.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty map with some capacity.

pub fn len(&self) -> usize

Number of elements in the map.

pub fn capacity(&self) -> usize

Capacity of the map.

pub fn next_index(&self) -> File

The next free index (wrapped self.len()).

pub fn last_index(&self) -> Option<File>

The last index in the map.

pub fn push(&mut self, elem: T) -> File

Pushes an element.

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

Pops an element.

pub fn clear(&mut self)

Clears a map.

pub fn iter(&self) -> Iter<T>

Iterates over the elements.

Important traits for FileIter<&'a Files<T>>

impl<'a, T: 'a> Iterator for FileIter<&'a Files<T>> type Item = (File, &'a T);impl<'a, T: 'a> Iterator for FileIter<IterMut<'a, T>> type Item = (File, &'a mut T);impl<T> Iterator for FileIter<Files<T>> type Item = (File, T);

pub fn index_iter<'a>(&'a self) -> FileIter<&'a Files<T>> where
    T: 'a, 

Iterates over the elements with the index.

Important traits for FileIter<&'a Files<T>>

impl<'a, T: 'a> Iterator for FileIter<&'a Files<T>> type Item = (File, &'a T);impl<'a, T: 'a> Iterator for FileIter<IterMut<'a, T>> type Item = (File, &'a mut T);impl<T> Iterator for FileIter<Files<T>> type Item = (File, T);

pub fn index_iter_mut<'a>(&'a mut self) -> FileIter<IterMut<'a, T>> where
    T: 'a, 

Iterates over the elements with the index, mutable version.

Important traits for FileIter<&'a Files<T>>

impl<'a, T: 'a> Iterator for FileIter<&'a Files<T>> type Item = (File, &'a T);impl<'a, T: 'a> Iterator for FileIter<IterMut<'a, T>> type Item = (File, &'a mut T);impl<T> Iterator for FileIter<Files<T>> type Item = (File, T);

pub fn into_index_iter(self) -> FileIter<Files<T>>

Iterates over the elements with the index.

pub fn iter_mut(&mut self) -> IterMut<T>

Iterates over the elements (mutable version).

pub fn shrink_to_fit(&mut self)

Shrinks the capacity as much as possible.

pub fn swap(&mut self, a: File, b: File)

Swap from Vec.

pub fn swap_remove(&mut self, idx: File) -> T

Swap remove from Vec.

impl<T: Clone> Files<T>

pub fn of_elems(elem: T, size: usize) -> Self

Creates an empty vector with some capacity.

Methods from Deref<Target = Vec<T>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector's buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl<T: Eq> Eq for Files<T>

impl<T> Default for Files<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Clone> Clone for Files<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialOrd> PartialOrd<Files<T>> for Files<T>

fn partial_cmp(&self, other: &Files<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Files<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Files<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Files<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Files<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialEq> PartialEq<Files<T>> for Files<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Ord> Ord for Files<T>

fn cmp(&self, other: &Files<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T> IntoIterator for Files<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a Files<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Files<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, T>

Creates an iterator from a value.

impl<T> From<Vec<T>> for Files<T>

fn from(vec: Vec<T>) -> Self

Performs the conversion.

impl<T> Deref for Files<T>

type Target = Vec<T>

The resulting type after dereferencing.

fn deref(&self) -> &Vec<T>

Dereferences the value.

impl<T> Index<File> for Files<T>

type Output = T

The returned type after indexing.

fn index(&self, index: File) -> &T

Performs the indexing (container[index]) operation.

impl<T> Index<Range<usize>> for Files<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeInclusive<usize>> for Files<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeFrom<usize>> for Files<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeTo<usize>> for Files<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> IndexMut<File> for Files<T>

fn index_mut(&mut self, index: File) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: Debug> Debug for Files<T>

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

Formats the value using the given formatter.

impl<T> FromIterator<T> for Files<T>

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

Creates a value from an iterator.