D
Language
Phobos
Comparisons
object
std
std.base64
std.boxer
std.compiler
std.conv
std.cover
std.ctype
std.date
std.demangle
std.file
std.format
std.gc
std.intrinsic
std.math
std.md5
std.mmfile
std.openrj
std.outbuffer
std.path
std.process
std.random
std.regexp
std.socket
std.socketstream
std.stdint
std.stdio
std.cstream
std.stream
std.string
std.system
std.thread
std.uni
std.uri
std.utf
std.zip
std.zlib
std.c.fenv
std.c.math
std.c.process
std.c.stdarg
std.c.stddef
std.c.stdio
std.c.stdlib
std.c.string
std.c.time
std.c.wcharh
std.windows.charset
std.windows
std.linux
std.c.windows
std.c.linux
|
std.boxer
This module is a set of types and functions for converting any object (value
or heap) into a generic box type, allowing the user to pass that object
around without knowing what's in the box, and then allowing him to recover
the value afterwards.
Example:
Box b = box(45);
real r = unbox!(real)(b);
That is the basic interface and will usually be all that you need to
understand. If it cannot unbox the object to the given type, it throws
UnboxException. As demonstrated, it uses implicit casts to behave in the exact
same way that static types behave. So for example, you can unbox from int to
real, but you cannot unbox from real to int: that would require an explicit
cast.
This therefore means that attempting to unbox an int as a string will throw
an error instead of formatting it. In general, you can call the toString method
on the box and receive a good result, depending upon whether std.string.format
accepts it.
Boxes can be compared to one another and they can be used as keys for
associative arrays.
There are also functions for converting to and from arrays of boxes.
Example:
Box[] a = boxArray(1, 45.4, "foobar");
TypeInfo[] arg_types;
void* arg_data;
boxArrayToArguments(a, arg_types, arg_data);
a = boxArray(arg_types, arg_data);
One use of this is to support a variadic function more easily and robustly;
simply call "boxArray(arguments, argptr)", then do whatever you need to do
with the array.
Authors:
Burton Radons
License:
Public Domain
- enum TypeClass;
- The type class returned from Box.findTypeClass; the order of entries is important.
- Bool
- < bool
- Integer
- < byte, ubyte, short, ushort, int, uint, long, ulong
- Float
- < float, double, real
- Complex
- < cfloat, cdouble, creal
- Imaginary
- < ifloat, idouble, ireal
- Class
- < Inherits from Object
- Pointer
- < Pointer type (T *)
- Array
- < Array type (T [])
- Other
- < Any other type, such as delegates, function pointers, struct, void...
- struct Box;
- Box is a generic container for objects (both value and heap), allowing the
user to box them in a generic form and recover them later.
A box object contains a value in a generic fashion, allowing it to be
passed from one place to another without having to know its type. It is
created by calling the box function, and you can recover the value by
instantiating the unbox template.
- bool unboxable(TypeInfo test);
- Return whether this value could be unboxed as the given type without throwing.
- TypeInfo type();
- Property for the type contained by the box.
This is initially null and cannot be assigned directly.
Returns:
the type of the contained object.
- void[] data();
- Property for the data pointer to the value of the box.
This is initially null and cannot be assigned directly.
Returns:
the data array.
- char[] toString();
- Attempt to convert the boxed value into a string using std.string.format;
this will throw if that function cannot handle it. If the box is
uninitialized then this returns "".
- bool opEquals(Box other);
- Compare this box's value with another box. This implicitly casts if the
types are different, identical to the regular type system.
- float opCmp(Box other);
- Compare this box's value with another box. This implicitly casts if the
types are different, identical to the regular type system.
- uint toHash();
- Return the value's hash.
- Box box(...);
- Box the single argument passed to the function. If more or fewer than one
argument is passed, this will assert.
- Box box(TypeInfo type, void* data);
- Box the explicitly-defined object. type must not be null; data must not be
null if the type's size is greater than zero.
The data is copied.
- Box [] boxArray(TypeInfo[] types, void* data);
- Convert a list of arguments into a list of boxes.
- Box [] boxArray(...);
- Box each argument passed to the function, returning an array of boxes.
- void boxArrayToArguments(Box [] arguments, out TypeInfo[] types, out void* data);
- Convert an array of boxes into an array of arguments.
- class UnboxException: object.Exception;
- This class is thrown if unbox is unable to cast the value into the desired
result.
- Box object;
- This is the box that the user attempted to unbox.
- TypeInfo outputType;
- This is the type that the user attempted to unbox the value as.
- this(Box object, TypeInfo outputType);
- Assign parameters and create the message in the form
"Could not unbox from type ... to ... ."
- template unboxCastReal(T)
- A generic unboxer for the real numeric types.
- template unboxCastInteger(T)
- A generic unboxer for the integral numeric types.
- template unboxCastComplex(T)
- A generic unboxer for the complex numeric types.
- template unboxCastImaginary(T)
- A generic unboxer for the imaginary numeric types.
- template unbox(T)
- The unbox template takes a type parameter and returns a function that
takes a box object and returns the specified type.
To use it, instantiate the template with the desired result type, and then
call the function with the box to convert.
This will implicitly cast base types as necessary and in a way consistent
with static types - for example, it will cast a boxed byte into int, but it
won't cast a boxed float into short.
Throws:
UnboxException if it cannot cast
Example:
Box b = box(4.5);
bit u = unboxable!(real)(b); real r = unbox!(real)(b);
Box y = box(4);
int x = unbox!(int) (y);
- template unboxable(T)
- Return whether the value can be unboxed as the given type; if this returns
false, attempting to do so will throw UnboxException.
|