Crate starfish_common

Re-exports

• pub use chrono;
• pub use derive_more;
• pub use futures;
• pub use num_cpus;
• pub use rust_decimal;
• pub use rust_decimal_macros;
• pub use serde;
• pub use serde_json;
• pub use serde_urlencoded;
• pub use serde_with;
• pub use strum;
• pub use tokio;

Modules

• future
  Asynchronous values.
• runtime
• sink
  Asynchronous sinks.
• stream
  Asynchronous streams.

Macros

• anyhow
  Construct an ad-hoc error from a string or existing non-anyhow error value.
• bail
  Return early with an error.
• dec
  Convenience function for creating decimal numbers
• ensure
• join
  Waits on multiple concurrent branches, returning when all branches complete.
• json
  Construct a serde_json::Value from a JSON literal.
• select
  Waits on multiple concurrent branches, returning when the first branch completes, cancelling the remaining branches.

Structs

• AnyError
  The Error type, a wrapper around a dynamic error type.
• Arc
  A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
• DateDeprecated
  ISO 8601 calendar date with time zone.
• DateTime
  ISO 8601 combined date and time with time zone.
• Decimal
  Decimal represents a 128 bit representation of a fixed-precision decimal number. The finite set of values of type Decimal are of the form m / 10^e, where m is an integer such that -2⁹⁶ < m < 2⁹⁶, and e is an integer between 0 and 28 inclusive.
• Duration
  A Duration type to represent a span of time, typically used for system timeouts.
• FixedOffset
  The time zone with fixed offset, from UTC-23:59:59 to UTC+23:59:59.
• HashMap
  A hash map implemented with quadratic probing and SIMD lookup.
• Instant
  A measurement of a monotonically nondecreasing clock. Opaque and useful only with Duration.
• Local
  The local timescale.
• Mutex
  An asynchronous Mutex-like type.
• MutexGuard
  A handle to a held Mutex. The guard can be held across any .await point as it is Send.
• NaiveDate
  ISO 8601 calendar date without timezone. Allows for every proleptic Gregorian date from Jan 1, 262145 BCE to Dec 31, 262143 CE. Also supports the conversion from ISO 8601 ordinal and week date.
• NaiveDateTime
  ISO 8601 combined date and time without timezone.
• NaiveTime
  ISO 8601 time without timezone. Allows for the nanosecond precision and optional leap second representation.
• Receiver
  Receives values from the associated Sender.
• RwLock
  An asynchronous reader-writer lock.
• RwLockReadGuard
  RAII structure used to release the shared read access of a lock when dropped.
• Sender
  Sends values to the associated Receiver.
• StdDuration
  A Duration type to represent a span of time, typically used for system timeouts.
• UnboundedReceiver
  Receive values from the associated UnboundedSender.
• UnboundedSender
  Send values to the associated UnboundedReceiver.
• Utc
  The UTC time zone. This is the most efficient time zone when you don’t need the local time. It is also used as an offset (which is also a dummy type).
• VecDeque
  A double-ended queue implemented with a growable ring buffer.

Enums

• Cow
  A clone-on-write smart pointer.
• Month
  The month of the year.
• RoundingStrategy
  RoundingStrategy represents the different rounding strategies that can be used by round_dp_with_strategy.
• SecondsFormat
  Specific formatting options for seconds. This may be extended in the future, so exhaustive matching in external code is not recommended.
• StdResult
  Result is a type that represents either success (Ok) or failure (Err).
• Weekday
  The day of week.

Traits

• AsyncBufRead
  Read bytes asynchronously.
• AsyncRead
  Read bytes asynchronously.
• AsyncSeek
  Seek bytes asynchronously.
• AsyncWrite
  Write bytes asynchronously.
• Datelike
  The common set of methods for date component.
• FromPrimitive
  A generic trait for converting a number to a value.
• FromStr
  Parse a value from a string
• Future
  A future represents an asynchronous computation obtained by use of async.
• Offset
  The offset from the local time to UTC.
• One
  Defines a multiplicative identity element for Self.
• Signed
  Useful functions for signed numbers (i.e. numbers that can be negative).
• Sink
  A Sink is a value into which other values can be sent, asynchronously.
• Stream
  A stream of values produced asynchronously.
• SubsecRound
  Extension trait for subsecond rounding or truncation to a maximum number of digits. Rounding can be used to decrease the error variance when serializing/persisting to lower precision. Truncation is the default behavior in Chrono display formatting. Either can be used to guarantee equality (e.g. for testing) when round-tripping through a lower precision format.
• TimeZone
  The time zone.
• Timelike
  The common set of methods for time component.
• ToPrimitive
  A generic trait for converting a value to a number.
• TryFuture
  A convenience for futures that return Result values that includes a variety of adapters tailored to such futures.
• TryStream
  A convenience for streams that return Result values that includes a variety of adapters tailored to such futures.
• Zero
  Defines an additive identity element for Self.
• _
  An extension trait for Futures that provides a variety of convenient adapters.

Functions

• AnyOk
  Equivalent to Ok::<_, anyhow::Error>(value).
• channel
  Creates a bounded mpsc channel for communicating between asynchronous tasks with backpressure.
• ctrl_c
  Completes when a “ctrl-c” notification is sent to the process.
• interval
  Creates new Interval that yields with interval of period. The first tick completes immediately. The default MissedTickBehavior is Burst, but this can be configured by calling set_missed_tick_behavior.
• interval_at
  Creates new Interval that yields with interval of period with the first tick completing at start. The default MissedTickBehavior is Burst, but this can be configured by calling set_missed_tick_behavior.
• sleep
  Waits until duration has elapsed.
• sleep_until
  Waits until deadline is reached.
• spawn
  Spawns a new asynchronous task, returning a JoinHandle for it.
• timeout
  Requires a Future to complete before the specified duration has elapsed.
• timeout_at
  Requires a Future to complete before the specified instant in time.
• unbounded_channel
  Creates an unbounded mpsc channel for communicating between asynchronous tasks without backpressure.
• yield_now
  Yields execution back to the Tokio runtime.

Type Aliases

• Result
  Result<T, Error>