Module otter::prelude [−][src]
Re-exports
pub use crate::imports::flexi_logger;pub use crate::imports::thiserror;pub use crate::imports::serde_json;pub use std::fmt::Write as _;pub use std::os::linux::fs::MetadataExt as _;pub use boolinator::Boolinator as _;pub use either::Left;pub use either::Right;pub use slotmap::Key as _;pub use tempfile;pub use crate::imports::zipfile;pub use crate::deref_to_field;pub use crate::deref_to_field_mut;pub use crate::ensure_eq;pub use crate::format_by_fmt_hex;pub use crate::matches_doesnot;pub use crate::trace_dbg;pub use crate::want;pub use crate::wantok;pub use crate::wants;pub use crate::want_let;pub use crate::want_failed_internal;pub use crate::accounts::loaded_acl;pub use crate::accounts::loaded_acl::EffectiveACL;pub use crate::accounts::loaded_acl::LoadedAcl;pub use crate::accounts::loaded_acl::PermSet;pub use crate::accounts::*;pub use crate::authproofs;pub use crate::authproofs::Authorisation;pub use crate::authproofs::Unauthorised;pub use crate::authproofs::AuthorisationSuperuser;pub use crate::asseturl::*;pub use crate::bundles;pub use crate::bundles::InstanceBundles;pub use crate::bundles::MgmtBundleListExt;pub use crate::childio;pub use crate::commands::AccessTokenInfo;pub use crate::commands::AccessTokenReport;pub use crate::commands::MgmtError;pub use crate::commands::MgmtCommand;pub use crate::commands::MgmtResponse;pub use crate::commands::MgmtGameInstruction;pub use crate::commands::MgmtGameResponse;pub use crate::commands::MgmtBundleList;pub use crate::commands::MgmtGameUpdateMode;pub use crate::commands::ProgressUpdateMode;pub use crate::config::*;pub use crate::debugreader::DebugReader;pub use crate::error::*;pub use crate::fake_rng::*;pub use crate::gamestate::*;pub use crate::global::*;pub use crate::hidden::*;pub use crate::keydata::*;pub use crate::nwtemplates;pub use crate::mgmtchannel::*;pub use crate::occultilks::*;pub use crate::organise;pub use crate::packetframe::FrameReader;pub use crate::packetframe::FrameWriter;pub use crate::packetframe::ReadFrame;pub use crate::packetframe::WriteFrame;pub use crate::packetframe::ReadExt;pub use crate::packetframe::ResponseWriter;pub use crate::pcaliases::*;pub use crate::pcrender::*;pub use crate::pieces::*;pub use crate::progress;pub use crate::progress::ProgressInfo;pub use crate::progress::OriginatorExt as _;pub use crate::shapelib;pub use crate::shapelib::CircleShape;pub use crate::shapelib::RectShape;pub use crate::shapelib::ItemEnquiryData;pub use crate::shapelib::LibraryEnquiryData;pub use crate::shapelib::LibraryLoadError;pub use crate::slotmap_slot_idx::*;pub use crate::spec::*;pub use crate::spec::piece_specs::FaceColourSpecs;pub use crate::spec::piece_specs::SimpleCommon;pub use crate::sse;pub use crate::toml_de;pub use crate::timedfd::*;pub use crate::termprogress;pub use crate::tz::*;pub use crate::updates::*;pub use crate::utils::*;pub use crate::ui::*;pub use OccultationKindGeneral as OccKG;pub use OccultationKindAlwaysOk as OccKA;pub use PriOccultedGeneral as PriOG;Modules
A map based on a B-Tree.
A set based on a B-Tree.
Functionality for ordering and comparison.
Inspection and manipulation of the process’s environment.
Utilities for formatting and printing Strings.
Filesystem manipulation operations.
A hash map implemented with quadratic probing and SIMD lookup.
Traits, helpers, and type definitions for core I/O functionality.
Composable external iteration.
Basic functions for dealing with memory.
Multi-producer, single-consumer FIFO queue communication primitives.
Unicode string slices.
Native threads.
Temporal quantification.
Safe wrappers around functions found in libc “unistd.h” header
Platform-specific extensions to std for Unix platforms.
Void
Macros
Derive macro generating an impl of the trait Debug.
Derive macro generating an impl of the trait Hash.
Construct an ad-hoc error from a string or existing non-anyhow error
value.
Logs a message at the debug level.
Generate the boilerplate for a newtyped index struct, for use with
IndexVec.
Return early with an error if a condition is not satisfied.
Inspects an environment variable at compile time.
Logs a message at the error level.
Macro for writing nested if let expressions.
Adds downcasting support to traits that extend downcast::Downcast by defining forwarding
methods to the corresponding implementations on std::any::Any in the standard library.
A macro equivalent to the stdlib’s vec![], but producing an IndexVec.
Logs a message at the info level.
Create an iterator over the “cartesian product” of iterators.
Create an iterator running multiple iterators in lockstep.
The standard logging macro.
Determines if a message logged at the specified level in that module will be logged.
Throw an error.
Logs a message at the trace level.
Logs a message at the warn level.
Structs
Sample a u8, uniformly distributed over ASCII letters and numbers:
a-z, A-Z and 0-9.
A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
A vector with a fixed capacity.
A map based on a B-Tree.
A set based on a B-Tree.
The BufReader<R> struct adds buffering to any reader.
Wraps a writer and buffers its output.
Representation of a running or exited child process.
A process builder, providing fine-grained control over how a new process should be spawned.
A Condition Variable
Dense slot map, storage with stable unique keys.
A Duration type to represent a span of time, typically used for system
timeouts.
An enum mapping.
A reference to an open file on the filesystem.
Configuration for formatting.
A hash map implemented with quadratic probing and SIMD lookup.
A hash set implemented as a HashMap where the value is ().
A slice that only accepts indices of a specific type. Note that the intended
usage is as IndexSlice<I, [T]>.
A Vec that only accepts indices of a specific type.
A measurement of a monotonically nondecreasing clock.
Opaque and useful only with Duration.
Immutable struct that defines which loglines are to be written, based on the module, the log level, and the text.
A named temporary file.
An integer that is known not to equal zero.
A wrapper around floats providing implementations of Eq, Ord, and Hash.
Borrowed reference to an OS string (see OsString).
An owned, mutable path (akin to String).
Zero-sized type used to mark things that “act like” they own a T.
A compiled regular expression for matching Unicode strings.
The SHA-512 hash algorithm with the SHA-512 initial hash value.
The SHA-512 hash algorithm with the SHA-512/256 initial hash value. The result is truncated to 256 bits.
Sparse secondary map, associate data with previously stored elements in a slot map.
Double-ended queue with stable indices
Describes what to do with a standard I/O stream for a child process when
passed to the stdin, stdout, and stderr methods of Command.
The error type returned when a checked integral type conversion fails.
User identifier
Case Insensitive wrapper of strings.
A Unix stream socket.
A parsed URL record.
A double-ended queue implemented with a growable ring buffer.
Provides intentionally-wrapped arithmetic on T.
A struct for reading a zip file
Enums
Defines big-endian serialization.
A clone-on-write smart pointer.
The enum Either with variants Left and Right is a general purpose
sum type with two cases.
Value that either holds a single A or B, or both.
A list specifying general categories of I/O error.
The error type for errors that can never happen.
Defines little-endian serialization.
An Ordering is the result of a comparison between two values.
The empty type for cases which can’t occur.
Error type for Zip
Constants
Everything that is not an ASCII letter or digit.
Traits
A trait to emulate dynamic typing.
A trait to extract the raw unix file descriptor from an underlying object.
A trait for borrowing data.
Numbers which have upper and lower bounds
A BufRead is a type of Reader which has an internal buffer, allowing it
to perform extra ways of reading.
Unix-specific extensions to the process::Command builder.
An Eq-like trait that produces a Choice instead of a bool.
Provides the context method for Result.
? formatting.
Used for immutable dereferencing operations, like *v.
Used for mutable dereferencing operations, like in *v = 1;.
A data structure that can be deserialized from any data format supported by Serde.
A data structure that can be deserialized without borrowing any data from the deserializer.
A data format that can deserialize any data structure supported by Serde.
The Digest trait specifies an interface common for digest functions.
Format trait for an empty format, {}.
Supports conversion to Any. Traits to be extended by impl_downcast! must extend Downcast.
Simplifies the use of the DynCast trait by abstracting away the difference
between different ways of storing trait objects.
Enum mapping type
A trait for capturing the number of variants in Enum. This trait can be autoderived by
strum_macros.
Associates additional pieces of information with an Enum. This can be
autoimplemented by deriving EnumMessage and annotating your variants with
`#[strum(message=“…”)].
EnumProperty is a trait that makes it possible to store additional information
with enum variants. This trait is designed to be used with the macro of the same
name in the strum_macros crate. Currently, the only string literals are supported
in attributes, the other methods will be implemented as additional attribute types
become stabilized.
Error is a trait representing the basic expectations for error values,
i.e., values of type E in Result<T, E>.
Unix-specific extensions to process::ExitStatus and
ExitStatusError.
Extension trait for std::fs::File which provides allocation, duplication and locking methods.
A generic trait for converting a number to a value.
Parse a value from a string
A hashable type.
A trait for hashing an arbitrary stream of bytes.
Used for indexing operations (container[index]) in immutable contexts.
Used for indexing operations (container[index]) in mutable contexts.
This trait designates that an Enum can be iterated over. It can
be auto generated using strum_macros on your behalf.
A trait to express the ability to consume an object and acquire ownership of its raw file descriptor.
An Iterator blanket implementation that provides extra adaptors and
methods.
Unix-specific extensions to fs::Metadata.
Unix-specific extensions to fs::OpenOptions.
Platform-specific extensions to OsStr.
The Read trait allows for reading bytes from a source.
Extends Read with methods for reading numbers. (For std::io.)
Extensions to Result<Void, E>
Extensions to Result<T, Void>
An automatically-implemented extension trait on RngCore providing high-level
generic methods for sampling values and other convenience methods.
A data structure that can be serialized into any data format supported by Serde.
Returned from Serializer::serialize_tuple.
A data format that can serialize any data structure supported by Serde.
Extension trait on slices, providing random mutation and sampling methods.
A generic trait for converting a value to a number.
Simple and safe type conversions that may fail in a controlled
way under some circumstances. It is the reciprocal of TryInto.
An attempted conversion that consumes self, which may or may not be
expensive.
A trait for objects which are byte-oriented sinks.
Extends Write with methods for writing numbers. (For std::io.)
A trait for writing or formatting into Unicode-accepting buffers or streams.
Functions
Get the time of the specified clock, (see clock_gettime(2)).
Terminates the current process with the specified exit code.
Compares and returns the maximum of two values.
Compares and returns the minimum of two values.
Percent-decode the given string.
Creates a new iterator that repeats elements of type A endlessly by
applying the provided closure, the repeater, F: FnMut() -> A.
Puts the current thread to sleep for at least the specified amount of time.
Retrieve the lazily-initialized thread-local random number generator,
seeded by the system. Intended to be used in method chaining style,
e.g. thread_rng().gen::<i32>(), or cached locally, e.g.
let mut rng = thread_rng();. Invoked by the Default trait, making
ThreadRng::default() equivalent.
A safe version of intrinsincs::unreachable.
Percent-encode the UTF-8 encoding of the given string.
Iterate i and j in lock step.
Type Definitions
A mutual exclusion primitive useful for protecting shared data
An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
A type alias for Infallible.
Raw file descriptors.
A reader-writer lock
RAII structure used to release the shared read access of a lock when dropped.
RAII structure used to release the exclusive write access of a lock when dropped.
Attribute Macros
Annotating a trait or enum definition with an #[enum_dispatch] attribute will register it
with the enum_dispatch library, allowing it to be used to generate impl blocks elsewhere.
See crate docs for more info.
Derive Macros
Deserialize value by using it’s FromStr implementation
Procedural derive generating enum_map::Enum implementation.
Add a constant usize equal to the number of variants.
Generate a new type with only the discriminant names.
Creates a new type that iterates of the variants of an enum.
Add a verbose message to an enum variant.
Add custom properties to enum variants.
Converts strings to enum variants based on their name.
Derives num_traits::FromPrimitive for simple enums and newtypes.
Implements From<MyEnum> for &'static str on an enum.
Serialize value by using it’s Display implementation
Derives num_traits::ToPrimitive for simple enums and newtypes.