Crate maelstrom_base

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

Modules

• manifest
• 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
• tty

Macros

• client_job_id_pocket_definition
• enum_set
  Creates a EnumSet literal, which can be used in const contexts.
• group_id_pocket_definition
• job_broker_status_pocket_definition
• job_completed_pocket_definition
• job_device_pocket_definition
• job_effects_pocket_definition
• job_mount_pocket_definition
• job_network_pocket_definition
• job_outcome_pocket_definition
• job_output_result_pocket_definition
• job_root_overlay_pocket_definition
• job_termination_status_pocket_definition
• job_tty_pocket_definition
• job_worker_status_pocket_definition
• nonempty
  Like the vec! macro, but enforces at least one argument. A nice short-hand for constructing NonEmpty values.
• timeout_pocket_definition
• user_id_pocket_definition
• window_size_pocket_definition
• worker_id_pocket_definition

Structs

• ClientId
  ID of a client connection. These share the same ID space as WorkerId and MonitorId.
• 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.
• JobCompleted
  The outcome of a completed job. That is, a job that ran to completion, instead of timing out, being canceled, etc.
• JobDeviceIter
  An iterator over the variants of JobDevice
• JobEffects
  The output and duration of a job that ran for some amount of time. This is generated regardless of how the job terminated. From our point of view, it doesn’t matter. We ran the job until it was terminated, and gathered its output.
• JobId
  An absolute job ID that includes a ClientId for disambiguation.
• JobSpec
  All necessary information for the worker to execute a job.
• JobTty
  The parameters for a TTY for a job.
• MonitorId
  ID of a monitor connection. These share the same ID space as ClientId and WorkerId.
• NonEmpty
  Non-empty vector.
• NonRootUtf8PathBuf
• NonRootUtf8PathBufTryFromError
• Sha256Digest
  A SHA-256 digest.
• Sha256DigestTryFromError
• Sha256DigestVerificationError
  Error indicating that two digests that should have matched didn’t.
• Timeout
  A count of seconds.
• UserId
  ID of a user. This should be compatible with uid_t.
• Utf8Path
  A slice of a UTF-8 path (akin to str).
• Utf8PathBuf
  An owned, mutable UTF-8 path (akin to String).
• WindowSize
  The size of a terminal in characters.
• WorkerId
  ID of a worker connection. These share the same ID space as ClientId and MonitorId.

Enums

• ArtifactType
• JobBrokerStatus
• JobDevice
• JobDeviceForTomlAndJson
• JobError
  A job failed to execute for some reason. We separate the universe of errors into “execution” errors and “system” errors.
• JobMount
• JobMountForTomlAndJson
• JobNetwork
• JobOutcome
  The outcome of a job. This doesn’t include error outcomes, which are handled with JobError.
• JobOutputResult
  The result for stdout or stderr for a job.
• JobRootOverlay
• JobTerminationStatus
  How a job’s process terminated. A process can either exit of its own accord or be killed by a signal.
• JobWorkerStatus
• Utf8Component
  A single component of a path.

Type Aliases

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