Struct RegionID 

pub struct RegionID { /* private fields */ }

Unique identifier for a brain region, based on UUID v7.

This struct provides type safety and ensures global uniqueness for brain region IDs. UUID v7 is time-ordered, which provides better database indexing and sortability. It handles serialization to and deserialization from string representations of UUIDs.

Examples

use feagi_structures::genomic::brain_regions::RegionID;

// Generate a new time-ordered RegionID
let region_id = RegionID::new();

// Convert to string for storage/display
let id_string = region_id.to_string();

// Parse from string
let parsed_id = RegionID::from_string(&id_string).unwrap();
assert_eq!(region_id, parsed_id);

Implementations

impl RegionID

pub fn new() -> Self

Generates a new, time-ordered RegionID (UUID v7).

UUID v7 uses a timestamp-based approach, providing natural sorting and better database performance compared to random UUIDs.

Examples

use feagi_structures::genomic::brain_regions::RegionID;

let region_id = RegionID::new();
assert_ne!(region_id.to_string(), "");

pub fn from_uuid(uuid: Uuid) -> Self

Creates a RegionID from a UUID.

Examples

use feagi_structures::genomic::brain_regions::RegionID;
use uuid::Uuid;

let uuid = Uuid::now_v7();
let region_id = RegionID::from_uuid(uuid);
assert_eq!(region_id.as_uuid(), uuid);

pub fn from_string(s: &str) -> Result<Self, FeagiDataError>

Tries to create a RegionID from a string.

Returns an error if the string is not a valid UUID.

Examples

use feagi_structures::genomic::brain_regions::RegionID;

let region_id = RegionID::from_string("550e8400-e29b-41d4-a716-446655440000").unwrap();
assert_eq!(region_id.to_string(), "550e8400-e29b-41d4-a716-446655440000");

pub fn as_uuid(&self) -> Uuid

Returns the underlying UUID.

Examples

use feagi_structures::genomic::brain_regions::RegionID;

let region_id = RegionID::new();
let uuid = region_id.as_uuid();

pub fn as_bytes(&self) -> &[u8; 16]

Returns the byte representation of the UUID.

Examples

use feagi_structures::genomic::brain_regions::RegionID;

let region_id = RegionID::new();
let bytes = region_id.as_bytes();
assert_eq!(bytes.len(), 16);

Trait Implementations

impl Clone for RegionID

fn clone(&self) -> RegionID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RegionID

impl Debug for RegionID

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

Formats the value using the given formatter.

impl Default for RegionID

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RegionID

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RegionID

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

Formats the value using the given formatter.

impl Eq for RegionID

impl From<RegionID> for Uuid

fn from(region_id: RegionID) -> Self

Converts to this type from the input type.

impl From<Uuid> for RegionID

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

impl FromStr for RegionID

type Err = FeagiDataError

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 Hash for RegionID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RegionID

fn eq(&self, other: &RegionID) -> 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 Serialize for RegionID

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RegionID