Struct StorageBuilder

pub struct StorageBuilder<const INIT: bool = false> { /* private fields */ }

Available on crate feature elli only.

Used to construct a StorageManager

This builder contains multiple options which can be used to configure the location and type in which results are stored. To get an overview over all possible options, we refer to the module documentation.

use cellular_raza_core::storage::{StorageBuilder, StorageOption};

let storage_priority = StorageOption::default_priority();
let storage_builder = StorageBuilder::new()
    .priority(storage_priority)
    .location("./");

Implementations

impl<const INIT: bool> StorageBuilder<INIT>

pub fn priority( self, priority: impl IntoIterator<Item = StorageOption>, ) -> StorageBuilder<INIT>

Available on crate feature cpu_os_threads only.

Define the priority of StorageOption. See StorageOption::default_priority.

pub fn get_priority(&self) -> UniqueVec<StorageOption>

Available on crate feature cpu_os_threads only.

Get the current priority

pub fn suffix(self, suffix: impl Into<PathBuf>) -> StorageBuilder<INIT>

Available on crate feature cpu_os_threads only.

Define a suffix which will be appended to the save path

pub fn get_suffix(&self) -> PathBuf

Available on crate feature cpu_os_threads only.

Get the current suffix

pub fn add_date(self, add_date: bool) -> StorageBuilder<INIT>

Available on crate feature cpu_os_threads only.

Store results by their current date inside the specified folder path

pub fn get_add_date(&self) -> bool

Available on crate feature cpu_os_threads only.

Get information if the current date should be appended to the storage path

impl StorageBuilder

pub fn new() -> StorageBuilder

Available on crate feature cpu_os_threads only.

Constructs a new StorageBuilder with default settings.

use cellular_raza_core::storage::StorageBuilder;
let storage_builder = StorageBuilder::new();

pub fn init(self) -> StorageBuilder<true>

Available on crate feature cpu_os_threads only.

Initializes the StorageBuilder thus filling information about time.

pub fn init_with_date(self, date: &Path) -> StorageBuilder<true>

Available on crate feature cpu_os_threads only.

Specify the time at which the results should be saved

pub fn location<P>(self, location: P) -> StorageBuilder

where PathBuf: From<P>,

Available on crate feature cpu_os_threads only.

Define a folder where to store results

Note that this functionality is only available as long as the StorageBuilder has not been initialized.

pub fn get_location(&self) -> PathBuf

Available on crate feature cpu_os_threads only.

Get the current storage_location

Note that this functionality is only available as long as the StorageBuilder has not been initialized.

impl StorageBuilder<true>

pub fn get_full_path(&self) -> PathBuf

Available on crate feature cpu_os_threads only.

Get the fully constructed path after the Builder has been initialized with the StorageBuilder::init function.

pub fn de_init(self) -> StorageBuilder

Available on crate feature cpu_os_threads only.

De-initializes the StorageBuilder, making it possible to edit it again.

Trait Implementations

impl<const INIT: bool> Clone for StorageBuilder<INIT>

fn clone(&self) -> StorageBuilder<INIT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const INIT: bool> Debug for StorageBuilder<INIT>

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

Formats the value using the given formatter.

impl<'de, const INIT: bool> Deserialize<'de> for StorageBuilder<INIT>

fn deserialize<__D>( __deserializer: __D, ) -> Result<StorageBuilder<INIT>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const INIT: bool> Serialize for StorageBuilder<INIT>

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.