# core

## Structs

- [`Asset`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Asset.md "nominal::core::Asset"): Represents an asset in Nominal.
- [`AssetCreate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetCreate.md "nominal::core::AssetCreate"): Parameters for creating a new asset.
- [`AssetUpdate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetUpdate.md "nominal::core::AssetUpdate")
- [`AssetsClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetsClient.md "nominal::core::AssetsClient"): Client for asset collection operations (list, get).
- [`CatalogClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CatalogClient.md "nominal::core::CatalogClient"): Client for catalog operations: datasets, videos, connections, and channels.
- [`Channel`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Channel.md "nominal::core::Channel"): A time-series channel on a data source (dataset, video, connection, etc.).
- [`ChannelQuery`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ChannelQuery.md "nominal::core::ChannelQuery"): A query for searching channels.
- [`ChannelUpdate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ChannelUpdate.md "nominal::core::ChannelUpdate"): An update to a channel’s metadata. Only optional fields that are set will change.
- [`Connection`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Connection.md "nominal::core::Connection"): Represents a connection in Nominal.
- [`ConnectionUpdate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ConnectionUpdate.md "nominal::core::ConnectionUpdate"): An update to connection metadata. Only fields that are set will be changed.
- [`Dataset`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Dataset.md "nominal::core::Dataset"): Represents a dataset in Nominal.
- [`DatasetCreate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DatasetCreate.md "nominal::core::DatasetCreate"): Parameters for creating a new dataset.
- [`DatasetUpdate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DatasetUpdate.md "nominal::core::DatasetUpdate"): An update to dataset metadata. Only fields that are set will be changed.
- [`Video`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Video.md "nominal::core::Video"): Represents a video in Nominal.
- [`VideoCreate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.VideoCreate.md "nominal::core::VideoCreate"): Parameters for creating a new video.
- [`VideoUpdate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.VideoUpdate.md "nominal::core::VideoUpdate"): An update to video metadata. Only fields that are set will be changed.
- [`CheckLiveStatus`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CheckLiveStatus.md "nominal::core::CheckLiveStatus"): Per-check status reported by a running streaming checklist.
- [`Checklist`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Checklist.md "nominal::core::Checklist"): Represents a checklist in Nominal.
- [`ChecklistLiveStatus`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ChecklistLiveStatus.md "nominal::core::ChecklistLiveStatus"): Live status of a streaming checklist executing against an asset.
- [`ChecklistsClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ChecklistsClient.md "nominal::core::ChecklistsClient"): Client for checklist collection operations (get, search) and streaming attachment.
- [`ExecuteStreamingChecklist`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ExecuteStreamingChecklist.md "nominal::core::ExecuteStreamingChecklist"): Options for [`ChecklistsClient::execute_streaming`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ChecklistsClient.md#method.execute_streaming "nominal::core::ChecklistsClient::execute_streaming").
- [`Directory`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Directory.md "nominal::core::Directory"): A directory entry produced by listing a drive path.
- [`Drive`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Drive.md "nominal::core::Drive"): Represents a drive in the Nominal file store.
- [`DriveFilesClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DriveFilesClient.md "nominal::core::DriveFilesClient"): Client for file operations scoped to a single drive in the Nominal file store.
- [`DrivesClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DrivesClient.md "nominal::core::DrivesClient"): Client for drive operations in the Nominal file store.
- [`FileRevision`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.FileRevision.md "nominal::core::FileRevision"): A single revision in a managed file’s history.
- [`LogicalFile`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.LogicalFile.md "nominal::core::LogicalFile"): A file at a path in a drive, along with its current revision.
- [`AvroStreamIngest`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AvroStreamIngest.md "nominal::core::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`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CsvIngest.md "nominal::core::CsvIngest"): Configuration for ingesting a CSV file into an existing dataset.
- [`DataflashIngest`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DataflashIngest.md "nominal::core::DataflashIngest"): Configuration for ingesting an ArduPilot DataFlash (`.bin`) file into a dataset.
- [`IngestClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.IngestClient.md "nominal::core::IngestClient"): Client for uploading files and managing ingest jobs.
- [`IngestJob`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.IngestJob.md "nominal::core::IngestJob"): A snapshot of an ingest job’s server-side state.
- [`JournalJsonIngest`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.JournalJsonIngest.md "nominal::core::JournalJsonIngest"): Configuration for ingesting a journald JSON (`.jsonl` / `.jsonl.gz`) file into a dataset.
- [`McapIngest`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.McapIngest.md "nominal::core::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`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.ParquetIngest.md "nominal::core::ParquetIngest"): Configuration for ingesting a Parquet file into an existing dataset.
- [`Timestamp`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Timestamp.md "nominal::core::Timestamp"): How timestamps are encoded in a file, plus which column holds them.
- [`UploadOptions`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.UploadOptions.md "nominal::core::UploadOptions"): Knobs for the network-side of a multipart upload.
- [`VideoIngest`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.VideoIngest.md "nominal::core::VideoIngest"): Configuration for ingesting a video into an existing or new video resource.
- [`Run`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Run.md "nominal::core::Run"): Represents a run in Nominal.
- [`RunCreate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunCreate.md "nominal::core::RunCreate"): Parameters for creating a new run.
- [`RunUpdate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunUpdate.md "nominal::core::RunUpdate")
- [`RunsClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunsClient.md "nominal::core::RunsClient"): Client for run collection operations (list, get).
- [`Template`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Template.md "nominal::core::Template"): Represents a workbook template in Nominal.
- [`TemplatesClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.TemplatesClient.md "nominal::core::TemplatesClient"): Client for template operations (get).
- [`UsersClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.UsersClient.md "nominal::core::UsersClient"): Client for user operations.
- [`Workbook`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.Workbook.md "nominal::core::Workbook"): Represents a workbook in Nominal.
- [`WorkbookCreate`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.WorkbookCreate.md "nominal::core::WorkbookCreate"): Parameters for creating a workbook from a template.
- [`WorkbooksClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.WorkbooksClient.md "nominal::core::WorkbooksClient"): Client for workbook collection operations (get, search).
- [`WorkspacesClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.WorkspacesClient.md "nominal::core::WorkspacesClient"): Thin wrapper around the workspace API, used during profile validation to confirm that credentials can reach a workspace.

## Enums

- [`AssetQuery`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.AssetQuery.md "nominal::core::AssetQuery"): A query for searching assets, which can be composed into a tree with [`and`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.AssetQuery.md#method.and "nominal::core::AssetQuery::and") and [`or`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.AssetQuery.md#method.or "nominal::core::AssetQuery::or").
- [`ChannelDataType`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.ChannelDataType.md "nominal::core::ChannelDataType"): The data type of a channel’s values.
- [`DatasetQuery`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DatasetQuery.md "nominal::core::DatasetQuery"): A query for searching datasets, composable with [`and`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DatasetQuery.md#method.and "nominal::core::DatasetQuery::and") and [`or`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DatasetQuery.md#method.or "nominal::core::DatasetQuery::or").
- [`VideoQuery`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.VideoQuery.md "nominal::core::VideoQuery"): A query for searching videos, composable with [`and`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.VideoQuery.md#method.and "nominal::core::VideoQuery::and") and [`or`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.VideoQuery.md#method.or "nominal::core::VideoQuery::or").
- [`CheckStatus`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.CheckStatus.md "nominal::core::CheckStatus"): Result of a single check evaluation.
- [`ChecklistQuery`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.ChecklistQuery.md "nominal::core::ChecklistQuery"): A query for searching checklists, composable with [`and`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.ChecklistQuery.md#method.and "nominal::core::ChecklistQuery::and") and [`or`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.ChecklistQuery.md#method.or "nominal::core::ChecklistQuery::or").
- [`ChecklistState`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.ChecklistState.md "nominal::core::ChecklistState"): Execution state of a streaming checklist.
- [`DataSource`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DataSource.md "nominal::core::DataSource"): A data source attached to an asset or run by name.
- [`DriveKind`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DriveKind.md "nominal::core::DriveKind"): A compatibility summary of a drive’s storage model.
- [`DriveMutability`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DriveMutability.md "nominal::core::DriveMutability"): Whether a drive’s contents can be modified through Nominal.
- [`DriveSource`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DriveSource.md "nominal::core::DriveSource"): Where a drive’s files come from.
- [`DriveState`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DriveState.md "nominal::core::DriveState"): The lifecycle state of a drive.
- [`FileEntry`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.FileEntry.md "nominal::core::FileEntry"): One entry returned by [`DriveFilesClient::list`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DriveFilesClient.md#method.list "nominal::core::DriveFilesClient::list"): either a file or a directory.
- [`FileOperationDestination`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.FileOperationDestination.md "nominal::core::FileOperationDestination"): A target for a file-store operation.
- [`FileState`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.FileState.md "nominal::core::FileState"): The lifecycle state of a file.
- [`DatasetTarget`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.DatasetTarget.md "nominal::core::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`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.FileType.md "nominal::core::FileType"): Recognized file formats for upload and ingest.
- [`IngestJobStatus`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.IngestJobStatus.md "nominal::core::IngestJobStatus"): The lifecycle status of an ingest job.
- [`IngestType`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.IngestType.md "nominal::core::IngestType"): The kind of data produced by an ingest job.
- [`TimeUnit`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.TimeUnit.md "nominal::core::TimeUnit"): The time unit used to interpret numeric timestamps in a file.
- [`UploadEvent`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.UploadEvent.md "nominal::core::UploadEvent"): Events emitted during a multipart upload.
- [`VideoTarget`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.VideoTarget.md "nominal::core::VideoTarget"): Where a video ingest should land. Either an existing video resource (by RID) or a new one, created atomically with the ingest.
- [`RunQuery`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.RunQuery.md "nominal::core::RunQuery"): A query for searching runs, which can be composed into a tree with [`and`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.RunQuery.md#method.and "nominal::core::RunQuery::and"), [`or`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.RunQuery.md#method.or "nominal::core::RunQuery::or"), and [`not`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.RunQuery.md#method.not "nominal::core::RunQuery::not").
- [`WorkbookDataScope`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.WorkbookDataScope.md "nominal::core::WorkbookDataScope"): A workbook’s data scope: either a set of assets or a set of runs.
- [`WorkbookQuery`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.WorkbookQuery.md "nominal::core::WorkbookQuery"): A query for searching workbooks, composable with [`and`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.WorkbookQuery.md#method.and "nominal::core::WorkbookQuery::and") and [`or`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.WorkbookQuery.md#method.or "nominal::core::WorkbookQuery::or").

## Type aliases

- [`ProgressCallback`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/type.ProgressCallback.md "nominal::core::ProgressCallback"): A callback invoked for each [`UploadEvent`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/enum.UploadEvent.md "nominal::core::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;
