Struct fbp::fbp_threadsafe_wrapper::ThreadSafeOptionType

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

Generic thread safe Option

Implementations

impl<T> ThreadSafeOptionType<T>

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);

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);

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();

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);

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");
}

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);

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());

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

impl<T> Clone for ThreadSafeOptionType<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ThreadSafeOptionType<T>

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

Formats the value using the given formatter.

impl<T> Default for ThreadSafeOptionType<T>

fn default() -> Self

Returns the “default value” for a type.