meshlib::std_shared_ptr_const_MR_Object Struct Reference

Inheritance diagram for meshlib::std_shared_ptr_const_MR_Object:

Public Member Functions
void	assign_from_another (other:&meshlib::std_shared_ptr_const_MR_Object)
auto	get () const -> Option<&meshlib::Object >
auto	has_value () const -> bool
auto	use_count () const -> core::ffi::c_int
void	reset ()
void	assign (ptr:&meshlib::Object)
void	assign_non_owning (ptr:Option<&meshlib::Object >)
void	assign_from_mutable (ptr:&meshlib::std_shared_ptr_MR_Object)
void	assign_aliasing (ownership:&meshlib::std_shared_ptr_const_void, ptr:Option<&meshlib::Object >)
auto	convert_to_mr_std_shared_ptr_const_void () const -> meshlib::Owned< meshlib::std_shared_ptr_const_void >
void	assign_to_mr_std_shared_ptr_const_void (_target:&mut meshlib::std_shared_ptr_const_void) const

Static Public Member Functions
static auto	new () -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >
static auto	construct_from_another (other:&meshlib::std_shared_ptr_const_MR_Object) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >
static auto	construct_from_value (value:meshlib::Owned< meshlib::Object >) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >
static auto	construct (ptr:&meshlib::Object) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >
static auto	construct_non_owning (ptr:Option<&meshlib::Object >) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >
static auto	construct_from_mutable (ptr:&meshlib::std_shared_ptr_MR_Object) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >
static auto	construct_aliasing (ownership:&meshlib::std_shared_ptr_const_void, ptr:Option<&meshlib::Object >) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >
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

Wraps a pointer to a single shared reference-counted heap-allocated const MR::Object.

Generated from class std::shared_ptr<const MR::Object>. Heap-allocated instances are held in Owned<std_shared_ptr_const_MR_Object>.

Member Function Documentation

assign()

void meshlib::std_shared_ptr_const_MR_Object::assign

(

ptr:&meshlib::Object

)

Overwrite the existing instance, taking ownership of an existing pointer. The previously owned object, if any, has its reference count decremented.

Calls MR_std_shared_ptr_const_MR_Object_Assign().

assign_aliasing()

void meshlib::std_shared_ptr_const_MR_Object::assign_aliasing	(	ownership:&meshlib::std_shared_ptr_const_void	,
		ptr:Option<&meshlib::Object >	)

The aliasing assignment. Overwrite an existing instance, copying ownership from an existing shared pointer and storing an arbitrary raw pointer. The input pointer can be reinterpreted from any other std::shared_ptr<T> to avoid constructing a new std::shared_ptr<void>.

Calls MR_std_shared_ptr_const_MR_Object_AssignAliasing(). The reference to the parameter ptr might be preserved in this object.

assign_from_another()

void meshlib::std_shared_ptr_const_MR_Object::assign_from_another

(

other:&meshlib::std_shared_ptr_const_MR_Object

)

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

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

assign_from_mutable()

void meshlib::std_shared_ptr_const_MR_Object::assign_from_mutable

(

ptr:&meshlib::std_shared_ptr_MR_Object

)

Overwrite the existing instance with a non-const pointer to the same type.

Calls MR_std_shared_ptr_const_MR_Object_AssignFromMutable().

assign_non_owning()

void meshlib::std_shared_ptr_const_MR_Object::assign_non_owning

(

ptr:Option<&meshlib::Object >

)

Overwrite the existing instance with a non-owning pointer. The previously owned object, if any, has its reference count decremented.

Calls MR_std_shared_ptr_const_MR_Object_AssignNonOwning(). The reference to the parameter ptr might be preserved in this object.

assign_to_mr_std_shared_ptr_const_void()

void meshlib::std_shared_ptr_const_MR_Object::assign_to_mr_std_shared_ptr_const_void

(

_target:&mut meshlib::std_shared_ptr_const_void

)

const

Overwrites an existing std::shared_ptr<void> to point to the same object as this instance.

Calls MR_std_shared_ptr_const_MR_Object_AssignTo_MR_std_shared_ptr_const_void().

construct()

auto meshlib::std_shared_ptr_const_MR_Object::construct ( ptr:&meshlib::Object ) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >

static

Create a new instance, taking ownership of an existing pointer.

Calls MR_std_shared_ptr_const_MR_Object_Construct().

construct_aliasing()

auto meshlib::std_shared_ptr_const_MR_Object::construct_aliasing ( ownership:&meshlib::std_shared_ptr_const_void , ptr:Option<&meshlib::Object >  ) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >

static

The aliasing constructor. Create a new instance, copying ownership from an existing shared pointer and storing an arbitrary raw pointer. The input pointer can be reinterpreted from any other std::shared_ptr<T> to avoid constructing a new std::shared_ptr<void>.

Calls MR_std_shared_ptr_const_MR_Object_ConstructAliasing(). The reference to the parameter ptr might be preserved in the constructed object.

construct_from_another()

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

static

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

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

construct_from_mutable()

auto meshlib::std_shared_ptr_const_MR_Object::construct_from_mutable ( ptr:&meshlib::std_shared_ptr_MR_Object ) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >

static

Create a new instance from a non-const pointer to the same type.

Calls MR_std_shared_ptr_const_MR_Object_ConstructFromMutable().

construct_from_value()

auto meshlib::std_shared_ptr_const_MR_Object::construct_from_value ( value:meshlib::Owned< meshlib::Object > ) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >

static

Construct from a value.

Calls MR_std_shared_ptr_const_MR_Object_ConstructFromValue(). The reference to the parameter value might be preserved in the constructed object.

construct_non_owning()

auto meshlib::std_shared_ptr_const_MR_Object::construct_non_owning ( ptr:Option<&meshlib::Object > ) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >

static

Create a new instance, storing a non-owning pointer.

Calls MR_std_shared_ptr_const_MR_Object_ConstructNonOwning(). The reference to the parameter ptr might be preserved in the constructed object.

convert_to_mr_std_shared_ptr_const_void()

auto meshlib::std_shared_ptr_const_MR_Object::convert_to_mr_std_shared_ptr_const_void

(

)

const -> meshlib::Owned< meshlib::std_shared_ptr_const_void >

Creates an untyped std::shared_ptr<void> pointing to the same object as the source typed pointer.

Calls MR_std_shared_ptr_const_MR_Object_ConvertTo_MR_std_shared_ptr_const_void().

get()

auto meshlib::std_shared_ptr_const_MR_Object::get

(

)

const -> Option<&meshlib::Object >

Returns the stored pointer, possibly null.

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

has_value()

auto meshlib::std_shared_ptr_const_MR_Object::has_value

(

)

const -> bool

Returns true if non-null.

Calls MR_std_shared_ptr_const_MR_Object_has_value().

new()

auto meshlib::std_shared_ptr_const_MR_Object::new ( ) -> meshlib::Owned< meshlib::std_shared_ptr_const_MR_Object >

static

Constructs an empty (default-constructed) instance.

Calls MR_std_shared_ptr_const_MR_Object_DefaultConstruct().

reset()

void meshlib::std_shared_ptr_const_MR_Object::reset

(

)

Resets the pointer to null.

Calls MR_std_shared_ptr_const_MR_Object_reset().

use_count()

auto meshlib::std_shared_ptr_const_MR_Object::use_count

(

)

const -> core::ffi::c_int

How many shared pointers share the managed object. Zero if no object is being managed. This being zero usually conincides with MR_std_shared_ptr_const_MR_Object_get() returning null, but is ultimately orthogonal. Note that in multithreaded environments, the only safe way to use this number is comparing it with zero. Positive values might change by the time you get to use them.

Calls MR_std_shared_ptr_const_MR_Object_use_count().

---

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

• std_shared_ptr_const_MR_Object.rs