Struct graphannis_core::graph::storage::disk_path::node_path::View

pub struct View<S: AsRef<[u8]>> { /* private fields */ }

The View struct defines the FieldView API. An instance of View wraps a storage (either borrowed or owned) and allows accessors for the layout fields.

This view is based on the following layout definition:

binary_layout!(node_path, LittleEndian, {
    length: u8,
    nodes: [u8; MAX_DEPTH * 8],
});

Implementations

impl<S: AsRef<[u8]>> View<S>

pub fn new(storage: S) -> Self

You can create views over a storage by calling View::new.

S is the type of underlying storage. It can be

• Immutable borrowed storage: &[u8]
• Mutable borrowed storage: &mut [u8]
• Owning storage: impl AsRef<u8> (for example: Vec<u8>)

pub fn into_storage(self) -> S

This destroys the view and returns the underlying storage back to you. This is useful if you created an owning view (e.g. based on Vec<u8>) and now need the underlying Vec<u8> back.

pub fn into_length(self) -> <length as StorageIntoFieldView<S>>::View

Destroy the View and return a field accessor to the length field owning the storage. This is mostly useful for FieldView::extract

pub fn into_nodes(self) -> <nodes as StorageIntoFieldView<S>>::View

Destroy the View and return a field accessor to the nodes field owning the storage. This is mostly useful for FieldView::extract

impl<S: AsRef<[u8]>> View<S>

pub fn length(&self) -> <length as StorageToFieldView<&[u8]>>::View

Return a FieldView with read access to the length field

pub fn nodes(&self) -> <nodes as StorageToFieldView<&[u8]>>::View

Return a FieldView with read access to the nodes field

impl<S: AsRef<[u8]> + AsMut<[u8]>> View<S>

pub fn length_mut(&mut self) -> <length as StorageToFieldView<&mut [u8]>>::View

Return a FieldView with write access to the length field

pub fn nodes_mut(&mut self) -> <nodes as StorageToFieldView<&mut [u8]>>::View

Return a FieldView with write access to the nodes field