Struct ThreadSafeOptionType

Source
pub struct ThreadSafeOptionType<T> { /* private fields */ }
Expand description

Generic thread safe Option

Implementations§

Source§

impl<T> ThreadSafeOptionType<T>

Source

pub fn new(option_to_wrap: Option<T>) -> Self

Creates a new ThreadSafeOptionType for a specific type

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;

let safe_bool: ThreadSafeOptionType<bool> = ThreadSafeOptionType::new(None);
Source

pub fn create(op_arc: Arc<Mutex<Option<T>>>) -> Self

Create a new ThreadSafeOptionType from an Arc<Mutex<Option>>

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;
use std::sync::{Arc, Mutex, MutexGuard};

let an_arc = Arc::new(Mutex::new(Some(false)));

let safe_bool_option = ThreadSafeType::create(an_arc);
Source

pub fn get_arc(&self) -> Arc<Mutex<Option<T>>>

Return the underlying arc used by the ThreadSafeOptionType

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;
use std::sync::{Arc, Mutex, MutexGuard};

let safe_bool_option = ThreadSafeOptionType::new(Some(false));
let the_arc = safe_bool_option.get_arc();
Source

pub fn set_arc(&mut self, new_arc: Arc<Mutex<Option<T>>>)

Change the underlying arc used by the ThreadSafeOptionType

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;
use std::sync::{Arc, Mutex, MutexGuard};

let mut safe_bool_option = ThreadSafeOptionType::new(Some(false));
let new_arc = Arc::new(Mutex::new(Some(true)));
safe_bool_option.set_arc(new_arc);
Source

pub fn get_option(&self) -> MutexGuard<'_, Option<T>>

Change the underlying option in a MutexGuard

NOTE: MutexGuard<Option> will dereference to the underlying Option

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;
use std::sync::{Arc, Mutex, MutexGuard};
use std::ops::Deref;

let mut safe_bool_option = ThreadSafeOptionType::new(Some(false));
let the_value = safe_bool_option.get_option();
if the_value.deref().unwrap() == true {
	println!("The value is true");
} else {
	println!("The value is false");
}
Source

pub fn set_option(&mut self, new_option: Option<T>)

Replace the underlying option in a ThreadSafeOptionType with a new option

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;
use std::sync::{Arc, Mutex, MutexGuard};
use std::ops::{DerefMut, Deref};

let mut safe_bool_option = ThreadSafeOptionType::new(None);
let new_option = Some(true);
safe_bool_option.set_option(new_option);
Source

pub fn is_none(&self) -> bool

Implement is_none for a ThreadSafeOptionType so that it works like a regular option

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;

let mut safe_bool_option: ThreadSafeOptionType<bool>  = ThreadSafeOptionType::new(None);
assert!(safe_bool_option.is_none());
Source

pub fn is_some(&self) -> bool

Implement is_some for a ThreadSafeOptionType so that it works like a regular option

§Example

Basic usage:

use fbp::fbp_threadsafe_wrapper::*;
let mut safe_bool_option = ThreadSafeOptionType::new(Some(true));
assert!(safe_bool_option.is_some());

Trait Implementations§

Source§

impl<T> Clone for ThreadSafeOptionType<T>

Source§

fn clone(&self) -> Self

Returns a duplicate 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<T: Debug> Debug for ThreadSafeOptionType<T>

Source§

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

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

impl<T> Default for ThreadSafeOptionType<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.