Crate scsys

scsys

Welcome to scsys, home to various primitives and utilities used throughout the scsys ecosystem. The sdk is heavily feature gated, reducing its footprint and allowing for a more modular approach to development.

Modules

• actors
  Actors
• errors
  Errors
• hkt
  Higher Kinded Types
• id
  Identity
• prelude
• state
  State
• sync
  Synchronization
• time
  Time
• traits
• types

Macros

• builder
• getter
• hkt

Structs

• Error
• State
  State is an abstract object that allows a particular kind of state to be associated with some data.

Enums

• Direction
• Errors

Traits

• Adjust
• Appellation
  An appellation is considered to be a name or title that is used to identify an object. For our purposes, an Appellation is a type that is used to identify an object in a computational space. The appellation outlines a notation that combines an idenfifier, classifier, and name into a single unique identifier for an object.
• AsSlice
• AsSliceMut
• Classifiable
  Interface for classifiable objects
• Classifier
  Denotes an object that may be used as a classifier
• DType
  DType provides additional information regarding the current type
• DTypeExt
• Decrement
  Decrement is a trait describing the ability to decrement a value.
• Increment
• IntoInner
  IntoInner is typically used for basic structures that wrap a single value.
• IsType
• Name
  Interface for nameable data-structures
• StringExt
• StringFmt
• TypeTag
  Typically, TypeTag is used for uninitaliziable enums with no variants

Functions

• collect_files_as
  A generic function wrapper extending glob::glob
• file_to_vec
  This function converts the file found at path (fp) into a Vec
• fnl_remove
  Remove the first and last charecters of a string
• project_root
  Fetch the project root unless specified otherwise with a CARGO_MANIFEST_DIR env variable
• type_of
  Compare two types

Type Aliases

• Arcm
  Type alias wrapping a locked, thread-safe structure with a [Mutex] in an [Arc]
• AsyncError
  Type alias for async errors
• AsyncResult
  Type alias for async results
• BoxError
  Type alias for a boxed error with send, sync, and static flags enabled
• BoxResult
  Type alias for the standard result used
• IOResult
  Type alias for std::io::Result
• Result
  A type alias for core::result::Result that employs the crate::errors::Error type

Derive Macros

• Display
• Keyed
• Params
  This macro generates a parameter struct and an enum of parameter keys.
• VariantConstructors
  This macro automatically generates functional constructors for all enclosed variants.