Unique

A unique pointer similar to C++'s std::unique_ptr.

struct Unique (

Type

Allocator = typeof(theAllocator())

Flag!"supportGC" supportGC = gcExists ? Flag!"supportGC".yes : Flag!"supportGC".no

) if (

isAllocator!Allocator

) {

import std.traits : hasMember;;

import std.typecons : Proxy;;

enum isSingleton;

enum isTheAllocator;

alias Pointer = Type;

alias Pointer = Type*;

this(Args args);

this(Allocator allocator, Args args);

static if(isGlobal)

static typeof(this) construct(Args args);

static if(!(isGlobal))

static typeof(this) construct(Allocator allocator, Args args);

this(Unique!(T, Allocator) other);

alias get = borrow;

Unique unique();

Pointer release();

Allocator allocator();

bool opCast();

void opAssign(Unique!(T, Allocator) other);

mixin Proxy!_object ;

}

Constructors

this this(Args args): The allocator is global, so no need to pass it in to the constructor
this this(Allocator allocator, Args args): Non-singleton allocator, must be passed in
this this(Unique!(T, Allocator) other)

Destructor

~this ~this()

Postblit

this(this) this(this)

Members

Aliases

Pointer alias Pointer = Type: Undocumented in source.
Pointer alias Pointer = Type*: Undocumented in source.
get alias get = borrow: Undocumented in source.

Functions

allocator Allocator allocator()
borrow auto borrow(): Borrow the owned pointer. Can be @safe with DIP1000 and if used in a scope fashion.
opAssign void opAssign(Unique!(T, Allocator) other): Move from another smart pointer
opCast bool opCast(): "Truthiness" cast
release Pointer release(): release ownership
unique Unique unique(): Releases ownership and transfers it to the returned Unique object.

Manifest constants

isGlobal enum isGlobal;: Undocumented in source.
isSingleton enum isSingleton;: Undocumented in source.
isTheAllocator enum isTheAllocator;: Undocumented in source.

Mixins

__anonymous mixin Proxy!_object: Undocumented in source.

Static functions

construct typeof(this) construct(Args args): Factory method so can construct with zero args.
construct typeof(this) construct(Allocator allocator, Args args): Factory method. Not necessary with non-global allocator but included for symmetry.

Meta

Source

See Implementation

automem unique manifest constants

gcExists

mixins

__anonymous

structs

Unique