Struct StorageBuilder

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

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§

Source§

impl<const INIT: bool> StorageBuilder<INIT>

Source

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

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

Source

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

Get the current priority

Source

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

Define a suffix which will be appended to the save path

Source

pub fn get_suffix(&self) -> PathBuf

Get the current suffix

Source

pub fn add_date(self, add_date: bool) -> Self

Store results by their current date inside the specified folder path

Source

pub fn get_add_date(&self) -> bool

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

Source§

impl StorageBuilder<false>

Source

pub fn new() -> Self

Constructs a new StorageBuilder with default settings.

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

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

Initializes the StorageBuilder thus filling information about time.

Source

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

Specify the time at which the results should be saved

Source

pub fn location<P>(self, location: P) -> Self
where PathBuf: From<P>,

Define a folder where to store results

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

Source

pub fn get_location(&self) -> PathBuf

Get the current storage_location

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

Source§

impl StorageBuilder<true>

Source

pub fn get_full_path(&self) -> PathBuf

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

Source

pub fn de_init(self) -> StorageBuilder<false>

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

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

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

Source§

impl<T> InteractionInf for T
where T: Send + Sync + Clone + Debug,

§

impl<T> Ungil for T
where T: Send,