Struct treeflection::context_vec::ContextVec

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

Implementations

impl<T> ContextVec<T>

The purpose of a ContextVec is to provide a way for commands to easily access relevant values. If we have a ContextVec named foo, the command foo[?] get will display the values in foo that the context points to.

Contents

• vector: Vec<T>
• context: Vec<usize>

Invariants

• the values in context will point to a valid value in vector
• the values in context will continue to point to the same value in vector (even after operations like insert and remove)

pub fn new() -> ContextVec<T>

Create a new empty ContextVec

pub fn from_vec(vector: Vec<T>) -> ContextVec<T>

Create a new ContextVec from a Vec

pub fn selection_first(&self) -> Option<&T>

Get the value currently pointed to by context

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

Mutably get the value currently pointed to by context

pub fn selection(&self) -> Vec<&T>

Get the values currently pointed to by context

pub fn get_context(&self) -> &[usize]

Get a slice of the context

pub fn into_context(self) -> Vec<usize>

Consume the ContextVec into the context

pub fn into_vector(self) -> Vec<T>

Consume the ContextVec into the vector

pub fn into_tuple(self) -> (Vec<usize>, Vec<T>)

Consume the ContextVec into a tuple of the context and the vector

pub fn clear_context(&mut self)

Clears the context

pub fn set_context(&mut self, value: usize)

Sets a new context

pub fn set_context_vec(&mut self, values: Vec<usize>)

Sets a new context

pub fn set_vec(&mut self, vector: Vec<T>)

Set to a new vector. Clears the context.

pub fn clear(&mut self)

Clears the vector and the context

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

Push a value to the end of the vector

pub fn insert(&mut self, index: usize, value: T)

Insert a value into the vector. Invalid context indices are updated.

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

Pop a value from the end of the vector. If it succeeds invalid context indices are removed.

pub fn remove(&mut self, to_remove: usize) -> T

Remove a value at the specified index. Deletes any context indices pointing to the removed value. Shifts all larger context indices down.

Trait Implementations

impl<T: Clone> Clone for ContextVec<T>

fn clone(&self) -> ContextVec<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for ContextVec<T>

fn default() -> ContextVec<T>

Returns the "default value" for a type.

impl<T> Deref for ContextVec<T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &[T]

Dereferences the value.

impl<T> DerefMut for ContextVec<T>

fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for ContextVec<T> where
    T: Deserialize<'de>, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Node for ContextVec<T> where
    T: Node + Serialize + DeserializeOwned + Default, 

fn node_step(&mut self, runner: NodeRunner) -> String

impl<T> Serialize for ContextVec<T> where
    T: Serialize, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.