MeshLib Rust Docs
Loading...
Searching...
No Matches
meshlib::expected_std_shared_ptr_MR_Object_std_string Struct Reference
Inheritance diagram for meshlib::expected_std_shared_ptr_MR_Object_std_string:

Public Member Functions

void assign_from_another (other:&meshlib::expected_std_shared_ptr_MR_Object_std_string)
auto success () const -> bool
auto value () const -> Option<&meshlib::std_shared_ptr_MR_Object >
auto error () const -> Option<&meshlib::std_string >
auto value_mut () -> Option<&mut meshlib::std_shared_ptr_MR_Object >
auto error_mut () -> Option<&mut meshlib::std_string >
auto as_result () const -> Result<&meshlib::std_shared_ptr_MR_Object, &meshlib::std_string >
 The value as Ok, or the error as Err.
auto as_result_mut () -> Result<&mut meshlib::std_shared_ptr_MR_Object, &mut meshlib::std_string >
 The value as Ok, or the error as Err, as mutable references.

Static Public Member Functions

static auto new () -> meshlib::Owned< meshlib::expected_std_shared_ptr_MR_Object_std_string >
static auto construct_from_another (other:&meshlib::expected_std_shared_ptr_MR_Object_std_string) -> meshlib::Owned< meshlib::expected_std_shared_ptr_MR_Object_std_string >
Static Public Member Functions inherited from meshlib::CppClass
static void destroy (ptr:*mut Self)
Static Public Member Functions inherited from meshlib::CppCopy
static auto copy (ptr:*const Self) -> *mut Self

Detailed Description

Stores either a std::shared_ptr<MR::Object> that represents success or a std::string that represents an error.

Generated from class expected<std::shared_ptr<MR::Object>, std::string>. Heap-allocated instances are held in Owned<expected_std_shared_ptr_MR_Object_std_string>.

Member Function Documentation

◆ as_result()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::as_result ( ) const -> Result<&meshlib::std_shared_ptr_MR_Object, &meshlib::std_string >

The value as Ok, or the error as Err.

◆ as_result_mut()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::as_result_mut ( ) -> Result<&mut meshlib::std_shared_ptr_MR_Object, &mut meshlib::std_string >

The value as Ok, or the error as Err, as mutable references.

◆ assign_from_another()

void meshlib::expected_std_shared_ptr_MR_Object_std_string::assign_from_another ( other:&meshlib::expected_std_shared_ptr_MR_Object_std_string )

Assigns the contents from another instance. Both objects remain alive after the call.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_AssignFromAnother(). The reference to the parameter other might be preserved in this object.

◆ construct_from_another()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::construct_from_another ( other:&meshlib::expected_std_shared_ptr_MR_Object_std_string ) -> meshlib::Owned< meshlib::expected_std_shared_ptr_MR_Object_std_string >
static

Constructs a copy of another instance. The source remains alive.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_ConstructFromAnother(). The reference to the parameter other might be preserved in the constructed object.

◆ error()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::error ( ) const -> Option<&meshlib::std_string >

If this instance represents an error, returns the stored std::string. Otherwise null.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_error(). The reference to this object might be preserved as the return value.

◆ error_mut()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::error_mut ( ) -> Option<&mut meshlib::std_string >

If this instance represents an error, returns the stored std::string. Otherwise null. This version returns a mutable pointer.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_error_mut(). The reference to this object might be preserved as the return value.

◆ new()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::new ( ) -> meshlib::Owned< meshlib::expected_std_shared_ptr_MR_Object_std_string >
static

Constructs an empty (default-constructed) instance.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_DefaultConstruct().

◆ success()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::success ( ) const -> bool

Returns true if this instance represents success, or false if it represents an error.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_success().

◆ value()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::value ( ) const -> Option<&meshlib::std_shared_ptr_MR_Object >

If this instance represents success, returns the stored std::shared_ptr<MR::Object>. Otherwise null.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_value(). The reference to this object might be preserved as the return value.

◆ value_mut()

auto meshlib::expected_std_shared_ptr_MR_Object_std_string::value_mut ( ) -> Option<&mut meshlib::std_shared_ptr_MR_Object >

If this instance represents success, returns the stored std::shared_ptr<MR::Object>. Otherwise null. This version returns a mutable pointer.

Calls MR_expected_std_shared_ptr_MR_Object_std_string_value_mut(). The reference to this object might be preserved as the return value.


The documentation for this struct was generated from the following file: