[][src]Module geng_core::prelude

Re-exports

pub use crate::draw_2d;
pub use ugli;

Modules

anyhow

github

crates-io

docs-rs

bincode

Bincode is a crate for encoding and decoding using a tiny binary serialization strategy. Using it, you can easily go from having an object in memory, quickly serialize it to bytes, and then deserialize it back just as fast!

distributions
futures

Abstractions for asynchronous programming.

log

A lightweight logging facade.

logger
microtask
once_cell

Overview

program_args
rand

Utilities for random number generation

serde

Serde

serde_json

Serde JSON

structopt

This crate defines the StructOpt trait and its custom derive.

trans
trans_schema

Macros

Debug

Derive macro generating an impl of the trait Debug.

btreemap

Create a BTreeMap from a list of key-value pairs

btreeset

Create a BTreeSet from a list of elements.

convert_args

Macro that converts the keys or key-value pairs passed to another maplit macro. The default conversion is to use the Into trait, if no custom conversion is passed.

debug

Logs a message at the debug level.

error

Logs a message at the error level.

hashmap

Create a HashMap from a list of key-value pairs

hashset

Create a HashSet from a list of elements.

info

Logs a message at the info level.

log_enabled

Determines if a message logged at the specified level in that module will be logged.

pin_mut

Pins a value on the stack.

trace

Logs a message at the trace level.

warn

Logs a message at the warn level.

Structs

AABB

Axis aligned bounding box.

Arc

A thread-safe reference-counting pointer. 'Arc' stands for 'Atomically Reference Counted'.

AutoSave
Cell

A mutable memory location.

Color
Error

The Error type, which can contain any failure.

Field
Geng
HashMap

A hash map implemented with quadratic probing and SIMD lookup.

HashSet

A hash set implemented as a HashMap where the value is ().

Mat4

4x4 matrix

Mutex

A mutual exclusion primitive useful for protecting shared data

Name
PhantomData

Zero-sized type used to mark things that "act like" they own a T.

Pin

A pinned pointer.

Quat
Range

A (half-open) range bounded inclusively below and exclusively above (start..end).

RangeInclusive

A range bounded inclusively below and above (start..=end).

Rc

A single-threaded reference-counting pointer. 'Rc' stands for 'Reference Counted'.

RealImpl
Ref

Wraps a borrowed reference to a value in a RefCell box. A wrapper type for an immutably borrowed value from a RefCell<T>.

RefCell

A mutable memory location with dynamically checked borrow rules

RefMut

A wrapper type for a mutably borrowed value from a RefCell<T>.

StdRng

The standard RNG. The PRNG algorithm in StdRng is chosen to be efficient on the current platform, to be statistically strong and unpredictable (meaning a cryptographically secure PRNG).

Struct
ThreadPool

Abstraction of a thread pool for basic parallelism.

Timer

Timer can be used to track time since some instant.

Ugli
Vec2

2-d vector.

Vec3

3-d vector.

Vec4

4-d vector.

Enums

Bound

An endpoint of a range of keys.

Schema
c_void

Equivalent to C's void type when used as a pointer.

Traits

Add

The addition operator +.

AddAssign

The addition assignment operator +=.

ApproxEq
AsyncBufRead

Read bytes asynchronously.

AsyncRead

Read bytes asynchronously.

AsyncSeek

Seek bytes asynchronously.

AsyncWrite

Write bytes asynchronously.

BufRead

A BufRead is a type of Reader which has an internal buffer, allowing it to perform extra ways of reading.

ColorComponent
Debug

? formatting.

Deref

Used for immutable dereferencing operations, like *v.

DerefMut

Used for mutable dereferencing operations, like in *v = 1;.

Deserialize

A data structure that can be deserialized from any data format supported by Serde.

Diff
Display

Format trait for an empty format, {}.

Distribution

Types (distributions) that can be used to create a random instance of T.

Div

The division operator /.

DivAssign

The division assignment operator /=.

DynClone

This trait is implemented by any type that implements std::clone::Clone.

Float
Future

A future represents an asynchronous computation.

Index

Used for indexing operations (container[index]) in immutable contexts.

IndexMut

Used for indexing operations (container[index]) in mutable contexts.

Mul

The multiplication operator *.

MulAssign

The multiplication assignment operator *=.

Neg

The unary negation operator -.

Num
RangeBounds

RangeBounds is implemented by Rust's built-in range types, produced by range syntax like .., a.., ..b, ..=c, d..e, or f..=g.

Read

The Read trait allows for reading bytes from a source.

Real
Rem

The remainder operator %.

RemAssign

The remainder assignment operator %=.

Rng

An automatically-implemented extension trait on RngCore providing high-level generic methods for sampling values and other convenience methods.

RngCore

The core of a random number generator.

Schematic
SeedableRng

A random number generator that can be explicitly seeded.

Serialize

A data structure that can be serialized into any data format supported by Serde.

Sink

A Sink is a value into which other values can be sent, asynchronously.

Stream

A stream of values produced asynchronously.

StructOpt

A struct that is converted from command line arguments.

Sub

The subtraction operator -.

SubAssign

The subtraction assignment operator -=.

Trans
TryFrom

Simple and safe type conversions that may fail in a controlled way under some circumstances. It is the reciprocal of TryInto.

TryFuture

A convenience for futures that return Result values that includes a variety of adapters tailored to such futures.

TryInto

An attempted conversion that consumes self, which may or may not be expensive.

TryStream

A convenience for streams that return Result values that includes a variety of adapters tailored to such futures.

UNum
Write

A trait for objects which are byte-oriented sinks.

_

An extension trait for Futures that provides a variety of convenient adapters.

_

Adapters specific to Result-returning futures

_

An extension trait which adds utility methods to AsyncRead types.

_

An extension trait which adds utility methods to AsyncWrite types.

_

An extension trait which adds utility methods to AsyncSeek types.

_

An extension trait which adds utility methods to AsyncBufRead types.

_

An extension trait for Streams that provides a variety of convenient combinator functions.

_

Adapters specific to Result-returning streams

_

An extension trait for Sinks that provides a variety of convenient combinator functions.

_
_

Extension trait on iterators, providing random sampling methods.

_

Extension trait on slices, providing random mutation and sampling methods.

Functions

add_translation
add_translations
clamp
clamp_abs
clone_box
default
global_rng
global_threadpool
index_range
max

Compares and returns the maximum of two values.

min

Compares and returns the minimum of two values.

min_max
partial_max
partial_min
partial_min_max
r32
r64
save_file
schema
select_file
set_locale
translate
vec2

Construct a 2-d vector with given components.

vec3

Construct a 3-d vector with given components.

vec4

Construct a 4-d vector with given components.

Type Definitions

R32
R64
c_char

Equivalent to C's char type.

c_double

Equivalent to C's double type.

c_float

Equivalent to C's float type.

c_int

Equivalent to C's signed int (int) type.

c_long

Equivalent to C's signed long (long) type.

c_short

Equivalent to C's signed short (short) type.

c_ulong

Equivalent to C's unsigned long type.

c_ushort

Equivalent to C's unsigned short type.

Derive Macros

Deserialize
Diff
Error
Schematic
Serialize
StructOpt

Generates the StructOpt impl.

Trans