core#

Structs#

  • Asset: Represents an asset in Nominal.

  • AssetCreate: Parameters for creating a new asset.

  • AssetUpdate

  • AssetsClient: Client for asset collection operations (list, get).

  • CatalogClient: Client for catalog operations: datasets, videos, connections, and channels.

  • Channel: A time-series channel on a data source (dataset, video, connection, etc.).

  • ChannelQuery: A query for searching channels.

  • ChannelUpdate: An update to a channel’s metadata. Only optional fields that are set will change.

  • Connection: Represents a connection in Nominal.

  • ConnectionUpdate: An update to connection metadata. Only fields that are set will be changed.

  • Dataset: Represents a dataset in Nominal.

  • DatasetCreate: Parameters for creating a new dataset.

  • DatasetUpdate: An update to dataset metadata. Only fields that are set will be changed.

  • Video: Represents a video in Nominal.

  • VideoCreate: Parameters for creating a new video.

  • VideoUpdate: An update to video metadata. Only fields that are set will be changed.

  • CheckLiveStatus: Per-check status reported by a running streaming checklist.

  • Checklist: Represents a checklist in Nominal.

  • ChecklistLiveStatus: Live status of a streaming checklist executing against an asset.

  • ChecklistsClient: Client for checklist collection operations (get, search) and streaming attachment.

  • ExecuteStreamingChecklist: Options for ChecklistsClient::execute_streaming.

  • Directory: A directory entry produced by listing a drive path.

  • Drive: Represents a drive in the Nominal file store.

  • DriveFilesClient: Client for file operations scoped to a single drive in the Nominal file store.

  • DrivesClient: Client for drive operations in the Nominal file store.

  • FileRevision: A single revision in a managed file’s history.

  • LogicalFile: A file at a path in a drive, along with its current revision.

  • AvroStreamIngest: Configuration for ingesting a Nominal Avro-stream (.avro) file into a dataset. The Avro record schema is fixed; see the server-side docs.

  • CsvIngest: Configuration for ingesting a CSV file into an existing dataset.

  • DataflashIngest: Configuration for ingesting an ArduPilot DataFlash (.bin) file into a dataset.

  • IngestClient: Client for uploading files and managing ingest jobs.

  • IngestJob: A snapshot of an ingest job’s server-side state.

  • JournalJsonIngest: Configuration for ingesting a journald JSON (.jsonl / .jsonl.gz) file into a dataset.

  • McapIngest: Configuration for ingesting an MCAP file’s protobuf timeseries data into a dataset. MCAP video tracks are a separate path and not yet wired up.

  • ParquetIngest: Configuration for ingesting a Parquet file into an existing dataset.

  • Timestamp: How timestamps are encoded in a file, plus which column holds them.

  • UploadOptions: Knobs for the network-side of a multipart upload.

  • VideoIngest: Configuration for ingesting a video into an existing or new video resource.

  • Run: Represents a run in Nominal.

  • RunCreate: Parameters for creating a new run.

  • RunUpdate

  • RunsClient: Client for run collection operations (list, get).

  • Template: Represents a workbook template in Nominal.

  • TemplatesClient: Client for template operations (get).

  • UsersClient: Client for user operations.

  • Workbook: Represents a workbook in Nominal.

  • WorkbookCreate: Parameters for creating a workbook from a template.

  • WorkbooksClient: Client for workbook collection operations (get, search).

  • WorkspacesClient: Thin wrapper around the workspace API, used during profile validation to confirm that credentials can reach a workspace.

Enums#

  • AssetQuery: A query for searching assets, which can be composed into a tree with and and or.

  • ChannelDataType: The data type of a channel’s values.

  • DatasetQuery: A query for searching datasets, composable with and and or.

  • VideoQuery: A query for searching videos, composable with and and or.

  • CheckStatus: Result of a single check evaluation.

  • ChecklistQuery: A query for searching checklists, composable with and and or.

  • ChecklistState: Execution state of a streaming checklist.

  • DataSource: A data source attached to an asset or run by name.

  • DriveKind: A compatibility summary of a drive’s storage model.

  • DriveMutability: Whether a drive’s contents can be modified through Nominal.

  • DriveSource: Where a drive’s files come from.

  • DriveState: The lifecycle state of a drive.

  • FileEntry: One entry returned by DriveFilesClient::list: either a file or a directory.

  • FileOperationDestination: A target for a file-store operation.

  • FileState: The lifecycle state of a file.

  • DatasetTarget: Where an ingest should land. Either an existing dataset (by RID) or a new dataset, which will be created atomically alongside the ingest — a failed ingest leaves no dataset behind.

  • FileType: Recognized file formats for upload and ingest.

  • IngestJobStatus: The lifecycle status of an ingest job.

  • IngestType: The kind of data produced by an ingest job.

  • TimeUnit: The time unit used to interpret numeric timestamps in a file.

  • UploadEvent: Events emitted during a multipart upload.

  • VideoTarget: Where a video ingest should land. Either an existing video resource (by RID) or a new one, created atomically with the ingest.

  • RunQuery: A query for searching runs, which can be composed into a tree with and, or, and not.

  • WorkbookDataScope: A workbook’s data scope: either a set of assets or a set of runs.

  • WorkbookQuery: A query for searching workbooks, composable with and and or.

Type aliases#

  • ProgressCallback: A callback invoked for each UploadEvent. Callbacks may be invoked from any task and must be cheap — emit to a channel or bounded buffer and do heavy work elsewhere.

Re-exports#

pub use client::NominalClient;
pub use client::NominalClientBuilder;
pub use user::User;
pub use workspace::Workspace;