ocean.core

Modules

Array
module ocean.core.Array

Array manipulation functions.

BitArray
module ocean.core.BitArray

This module contains a packed bit array implementation in the style of D's built-in dynamic arrays.

BitManip
module ocean.core.BitManip

This module contains a collection of bit-level operations.

Buffer
module ocean.core.Buffer

Utility for manipulation of reusable mutable array buffers.

Buffer_test
module ocean.core.Buffer_test

Unit tests for ocean.core.Buffer

ByteSwap
module ocean.core.ByteSwap
ContextUnion
module ocean.core.ContextUnion

Structure holding a user-specified context in the form of a pointer, a class reference or a platform-dependant unsigned integer (a hash_t).

DeepCompare
module ocean.core.DeepCompare

Value comparison for structs and arbitrary types.

Enforce
module ocean.core.Enforce

Exception utilities to write enforcements/

Enum
module ocean.core.Enum

Mixin for an enum class with the following basic features: * Contains an enum, called E, with members specified by an associative array passed to the mixin. * Implements an interface, IEnum, with common shared methods: * opIndex: look up an enum member's name by its value and vice-versa. * opIn_r: check whether a value (int) or name (char[]) is a member of the enum. * opApply: iteration over over the names & values of the enum's members. * length: returns the number of members in the enum. * min & max: return the minimum/maximum value of the enum's members. * A static opCall() method which returns a singleton instance of the class. This is the most convenient means of calling the methods listed above.

Exception
module ocean.core.Exception

Ocean Exceptions

ExceptionDefinitions
module ocean.core.ExceptionDefinitions

The exception module defines all system-level exceptions and provides a mechanism to alter system-level error handling.

MessageFiber
module ocean.core.MessageFiber

Wraps a Fiber allowing to pass a message on suspending/resuming and to kill the fiber.

Optional
module ocean.core.Optional

Wraps any type in a struct that also contains boolean field indicating if value is in defined state.

SmartEnum
module ocean.core.SmartEnum

Smart enum template class, encapsulates an enum with a map of its codes and descriptions.

SmartUnion
module ocean.core.SmartUnion

Template for a union that knows its active field and ensures the active field is read.

StructConverter
module ocean.core.StructConverter

Struct Converter functions

Test
module ocean.core.Test

Defines base exception class thrown by test checks and set of helper functions to define actual test cases. These helpers are supposed to be used in unittest blocks instead of asserts.

Tuple
module ocean.core.Tuple

The tuple module defines a template struct used for arbitrary data grouping.

TypeConvert
module ocean.core.TypeConvert

Functions to help with type conversion.

UnitTestRunner
module ocean.core.UnitTestRunner

Flexible unittest runner

Verify
module ocean.core.Verify

Utility intended as a replacement for assert to check for programming errors and sanity violations in situations when neither removing the check in -release mode nor bringing down the application by throwing an Error is acceptable.

VersionCheck
module ocean.core.VersionCheck

Helper utility for reflection on LibFeatures modules provided by libraries. If a library provides a module named libname.LibFeatures which defines constants of form const has_features_x_y = true where x is major version number and y is minor version number, helper defined in this module allows to query supported features with a standard API.

array
module ocean.core.array
buffer
module ocean.core.buffer