Crate maelstrom_base

Core structs used by the broker, worker, and clients. Everything in this crate must be usable from wasm.

Modules

• proto
  Messages sent between various binaries.
• ring_buffer
  This implements a simple ring-buffer backed by a vector that has serde support
• stats
  Contains data-structures for maintaining historical statistics of jobs

Macros

• enum_set
  Creates a EnumSet literal, which can be used in const contexts.
• nonempty
  Like the vec! macro, but enforces at least one argument. A nice short-hand for constructing NonEmpty values.

Structs

• ClientId
  ID of a client connection. These share the same ID space as WorkerId.
• ClientJobId
  A client-relative job ID. Clients can assign these however they like.
• EnumSet
  An efficient set type for enums.
• GroupId
  ID of a group. This should be compatible with gid_t.
• JobId
  An absolute job ID that includes a ClientId for disambiguation.
• JobMount
• JobSpec
  All necessary information for the worker to execute a job.
• JobSuccess
  The output of a job that was successfully executed. This doesn’t mean that the client will be happy with the job’s output. Maybe the job was killed by a signal, or it exited with an error status code. From our point of view, it doesn’t matter. We ran the job until it was terminated, and gathered its output.
• NonEmpty
  Non-empty vector.
• Sha256Digest
  A SHA-256 digest.
• Sha256DigestVerificationError
  Error indicating that two digests that should have matched didn’t.
• UserId
  ID of a user. This should be compatible with uid_t.
• Utf8PathBuf
  An owned, mutable UTF-8 path (akin to String).
• WorkerId
  ID of a worker connection. These share the same ID space as ClientId.

Enums

• JobDevice
• JobDeviceListDeserialize
• JobError
  A job failed to execute for some reason. We separate the universe of errors into “execution” errors and “system” errors.
• JobMountFsType
• JobOutputResult
  The result for stdout or stderr for a job.
• JobStatus
  How a job’s process terminated. A process can either exit of its own accord or be killed by a signal.

Type Aliases

• JobResult
  A common Result type in the worker.
• JobStringResult
  All relevant information about the outcome of a job. This is what’s sent around between the Worker, Broker, and Client.