Struct erupt::utils::VulkanResult

#[must_use = "this `VulkanResult` may be an error, which should be handled"]pub struct VulkanResult<T> {
    pub raw: Result,
    pub value: Option<T>,
}

Idiomatic wrapper around a Vulkan Result

Fields

raw: Result

The raw result from Vulkan

value: Option<T>

The value this wrapper type may be holding

Implementations

impl<T> VulkanResult<T>

pub fn new(raw: Result, value: T) -> VulkanResult<T>

Construct a new VulkanResult from raw and value

This will not populate self.value if the raw result is negative (Error)

pub fn unwrap(self) -> T

Returns the contained value, consuming self

Panics with the name of self.raw if self.value is None

pub fn expect(self, msg: impl Display) -> T

Returns the contained value, consuming self

Panics with msg and the name of self.raw if self.value is None

pub fn as_ref(&self) -> VulkanResult<&T>

Converts from &VulkanResult<T> to VulkanResult<&T>

Clones self.raw

pub fn as_mut(&mut self) -> VulkanResult<&mut T>

Converts from &mut VulkanResult<T> to VulkanResult<&mut T>

Clones self.raw

pub fn new_ok(value: T) -> VulkanResult<T>

Constructs a new VulkanResult from value

This will always set self.raw to vk::Result::SUCCESS

pub fn new_err(raw: Result) -> VulkanResult<T>

Constructs a new VulkanResult from raw

This will always set self.value to None

pub fn ok(self) -> Option<T>

Returns self.value, consuming self and dropping self.raw

pub fn result(self) -> Result<T, Result>

Maps Some(v) of self.value to Ok(v) and None of self.value to Err(self.raw)

pub fn map_err<F, O: FnOnce(Result) -> F>(self, op: O) -> Result<T, F>

Maps Some(v) of self.value to Ok(v) and None of self.value to Err(op(self.raw))

pub fn is_ok(&self) -> bool

Returns true if self.value is Some

pub fn raw_is_ok(&self) -> bool

Returns true if self.raw is positive

pub fn is_err(&self) -> bool

Returns true if self.value is None

pub fn raw_is_err(&self) -> bool

Returns true if self.raw is negative

Trait Implementations

impl<T: Clone> Clone for VulkanResult<T>

fn clone(&self) -> VulkanResult<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for VulkanResult<T>

impl<T> Debug for VulkanResult<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T: Default> Default for VulkanResult<T>

fn default() -> VulkanResult<T>

Returns the “default value” for a type.

impl<T> Display for VulkanResult<T> where
    T: Display, 

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

Formats the value using the given formatter.