[][src]Module skellige::prelude

All essential symbols in a simple consumable way

Examples

use skellige::prelude::*;

Modules

blake2

An implementation of the BLAKE2 hash functions.

fmt

Utilities for formatting and printing Strings.

fs

Filesystem manipulation operations.

git
gzip
io

Traits, helpers, and type definitions for core I/O functionality.

libc

libc - Raw FFI bindings to platforms' system libraries

macros
net
str

Unicode string slices.

sys
tar

Macros

cfgblock

Provides the ability to define #[cfg] statements for multiple items

defer

Ensure the given closure is executed once the surrounding scope closes despite panics. Inspired by Golang's defer, Java's finally and Ruby's ensure.

lazy_static

Structs

BufReader

The BufReader<R> struct adds buffering to any reader.

ColorString

Wrapper around the String type to provide colors and styles.

Defer
File

A reference to an open file on the filesystem.

OpenOptions

Options and flags which can be used to configure how a file is opened.

OsStr

Borrowed reference to an OS string (see OsString).

OsString

A type that can represent owned, mutable platform-native strings, but is cheaply inter-convertible with Rust strings.

Path

A slice of a path (akin to str).

PathBuf

An owned, mutable path (akin to String).

Regex

A compiled regular expression for matching Unicode strings.

Enums

Color

Color defines supported color types and provides static functions

Component

A single component of a path.

FileError
FuError

Define common error wrapper type

IterError

An error indicating something went wrong with an iterator operation

OsError
PathError
StringError
UserError

Constants

TERM_COLOR

Environment variable name for enabling/disabling color

Traits

BufRead

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

Colorable

Colorable defines a set of simple color functions for a given type

IteratorExt

Iterator adaptors to simplify some operations

LazyStatic

Support trait for enabling a few common operation on lazy static values.

MetadataExt

Unix-specific extensions to fs::Metadata.

OptionExt
PathColorExt
PathExt
PermissionsExt

Unix-specific extensions to fs::Permissions.

Read

The Read trait allows for reading bytes from a source.

Seek

The Seek trait provides a cursor which can be moved within a stream of bytes.

StringExt
ToStringExt
Write

A trait for objects which are byte-oriented sinks.

__Deref

Used for immutable dereferencing operations, like *v.

Functions

assert_iter_eq

Assert that the elements of the given iterables are equal and Panics when when not.

defer

Ensure the given closure is executed once the surrounding scope closes despite panics. Inspired by Golang's defer, Java's finally and Ruby's ensure.

initialize

Takes a shared reference to a lazy static and initializes it if it has not been already.

Type Definitions

FuResult

Result<T> provides a simplified result type with a common error type