Enum FileType 

pub enum FileType {
    Image,
    LidarPcd,
    LidarDepth,
    LidarReflect,
    RadarPcd,
    RadarCube,
    All,
}

File types supported in EdgeFirst Studio datasets.

Represents the different types of sensor data files that can be stored and processed in a dataset. EdgeFirst Studio supports various modalities including visual images and different forms of LiDAR and radar data.

String Representations

This enum has two string representations:

• Display (fmt::Display): Returns the server API type name (e.g., "lidar.depth") used when making API requests to EdgeFirst Studio.
• file_extension(): Returns the file extension for saving (e.g., "lidar.png") which may differ from the API type name.

Examples

use edgefirst_client::FileType;

// Create file types from strings
let image_type: FileType = "image".try_into().unwrap();
let lidar_type: FileType = "lidar.pcd".try_into().unwrap();

// Display file types
println!("Processing {} files", image_type); // "Processing image files"

// Use in dataset operations - example usage
let file_type = FileType::Image;
match file_type {
    FileType::Image => println!("Processing image files"),
    FileType::LidarPcd => println!("Processing LiDAR point cloud files"),
    _ => println!("Processing other sensor data"),
}

Variants

Image

Standard image files (JPEG, PNG, etc.)

LidarPcd

LiDAR point cloud data files (.pcd format)

LidarDepth

LiDAR depth images (.png format)

LidarReflect

LiDAR reflectance images (.jpg format)

RadarPcd

Radar point cloud data files (.pcd format)

RadarCube

Radar cube data files (.png format)

All

All sensor types - expands to all known file types

Implementations

impl FileType

pub fn file_extension(&self) -> &'static str

Returns the file extension to use when saving downloaded files. This may differ from the API type name (e.g., lidar.depth → lidar.png).

impl FileType

pub fn all_sensor_types() -> Vec<FileType>

Returns all concrete sensor file types (excludes All).

This is useful for expanding the All variant or listing available types.

Example

use edgefirst_client::FileType;

let all_types = FileType::all_sensor_types();
assert!(all_types.contains(&FileType::Image));
assert!(!all_types.contains(&FileType::All));

pub fn type_names() -> Vec<&'static str>

Returns all valid type names as strings for help text.

Example

use edgefirst_client::FileType;

let names = FileType::type_names();
assert!(names.contains(&"image"));
assert!(names.contains(&"all"));

pub fn expand_types(types: &[FileType]) -> Vec<FileType>

Expands a list of file types, replacing All with all concrete sensor types.

If the input contains FileType::All, returns all sensor types. Otherwise, returns the input types unchanged.

Example

use edgefirst_client::FileType;

let types = vec![FileType::All];
let expanded = FileType::expand_types(&types);
assert_eq!(expanded.len(), 6); // All concrete sensor types

let types = vec![FileType::Image, FileType::LidarPcd];
let expanded = FileType::expand_types(&types);
assert_eq!(expanded.len(), 2); // Unchanged

Trait Implementations

impl Clone for FileType

fn clone(&self) -> FileType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for FileType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Returns the server API type name for this file type. Used when making API requests to the server.

impl FromStr for FileType

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for FileType

fn eq(&self, other: &FileType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for FileType

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FileType

impl StructuralPartialEq for FileType