Struct ShortId 

pub struct ShortId(/* private fields */);

A newtype wrapper around a short ID string.

Provides a typed interface for working with short IDs, with methods for generation and conversion. The inner string is always a valid 14-character URL-safe identifier.

Examples

use short_id::ShortId;

// Generate a random ID
let id = ShortId::random();
assert_eq!(id.as_str().len(), 14);

// Convert to string
let s: String = id.into_string();

Implementations

impl ShortId

pub fn random() -> Self

Creates a new random short ID.

This is equivalent to calling short_id() but returns a typed ShortId.

Examples

use short_id::ShortId;

let id = ShortId::random();
assert_eq!(id.as_str().len(), 14);

Examples found in repository

examples/newtype.rs (line 5)

fn main() {
    // Create a random ID
    let id1 = ShortId::random();
    println!("Random ID: {}", id1);

    // Create a time-ordered ID
    let id2 = ShortId::ordered();
    println!("Ordered ID: {}", id2);

    // Access as string slice
    let s: &str = id1.as_str();
    println!("As str: {}", s);

    // Use AsRef<str>
    print_id(&id2);

    // Convert to String
    let string: String = id1.clone().into_string();
    println!("Into String: {}", string);

    // Create from String
    let id3: ShortId = string.into();
    println!("From String: {}", id3);

    // Compare IDs (PartialEq, Ord)
    let id4 = ShortId::random();
    let id5 = ShortId::random();
    println!("\nIDs are equal: {}", id4 == id5);
    println!("ID4 < ID5: {}", id4 < id5);
}

examples/basic.rs (line 34)

fn main() {
    println!("=== Functions ===");

    // Generate a random ID using the function
    let random_id = short_id();
    println!("short_id():         {random_id}");

    // Generate a time-ordered ID using the function
    #[cfg(feature = "std")]
    {
        let ordered = short_id_ordered();
        println!("short_id_ordered(): {ordered}");
    }

    println!("\n=== Macros ===");

    // Generate IDs using macros (convenient shorthand)
    let macro_id = id!();
    println!("id!():              {macro_id}");

    #[cfg(feature = "std")]
    {
        let macro_ordered = ordered_id!();
        println!("ordered_id!():      {macro_ordered}");
    }

    println!("\n=== Typed Wrapper ===");

    // Generate IDs using the ShortId type
    let typed_random = ShortId::random();
    println!("ShortId::random():  {typed_random}");

    #[cfg(feature = "std")]
    {
        let typed_ordered = ShortId::ordered();
        println!("ShortId::ordered(): {typed_ordered}");
    }

    // Demonstrate type conversions
    let s: String = typed_random.clone().into();
    println!("\nConverted to String: {s}");
    println!("Using as_str():      {}", typed_random.as_str());
    println!("Using AsRef<str>:    {}", typed_random.as_ref());
}

pub fn ordered() -> Self

Creates a new time-ordered short ID.

This is equivalent to calling short_id_ordered() but returns a typed ShortId. Requires the std feature (enabled by default).

Examples

use short_id::ShortId;

let id = ShortId::ordered();
assert_eq!(id.as_str().len(), 14);

Examples found in repository

examples/newtype.rs (line 9)

fn main() {
    // Create a random ID
    let id1 = ShortId::random();
    println!("Random ID: {}", id1);

    // Create a time-ordered ID
    let id2 = ShortId::ordered();
    println!("Ordered ID: {}", id2);

    // Access as string slice
    let s: &str = id1.as_str();
    println!("As str: {}", s);

    // Use AsRef<str>
    print_id(&id2);

    // Convert to String
    let string: String = id1.clone().into_string();
    println!("Into String: {}", string);

    // Create from String
    let id3: ShortId = string.into();
    println!("From String: {}", id3);

    // Compare IDs (PartialEq, Ord)
    let id4 = ShortId::random();
    let id5 = ShortId::random();
    println!("\nIDs are equal: {}", id4 == id5);
    println!("ID4 < ID5: {}", id4 < id5);
}

examples/basic.rs (line 39)

fn main() {
    println!("=== Functions ===");

    // Generate a random ID using the function
    let random_id = short_id();
    println!("short_id():         {random_id}");

    // Generate a time-ordered ID using the function
    #[cfg(feature = "std")]
    {
        let ordered = short_id_ordered();
        println!("short_id_ordered(): {ordered}");
    }

    println!("\n=== Macros ===");

    // Generate IDs using macros (convenient shorthand)
    let macro_id = id!();
    println!("id!():              {macro_id}");

    #[cfg(feature = "std")]
    {
        let macro_ordered = ordered_id!();
        println!("ordered_id!():      {macro_ordered}");
    }

    println!("\n=== Typed Wrapper ===");

    // Generate IDs using the ShortId type
    let typed_random = ShortId::random();
    println!("ShortId::random():  {typed_random}");

    #[cfg(feature = "std")]
    {
        let typed_ordered = ShortId::ordered();
        println!("ShortId::ordered(): {typed_ordered}");
    }

    // Demonstrate type conversions
    let s: String = typed_random.clone().into();
    println!("\nConverted to String: {s}");
    println!("Using as_str():      {}", typed_random.as_str());
    println!("Using AsRef<str>:    {}", typed_random.as_ref());
}

pub fn as_str(&self) -> &str

Returns the ID as a string slice.

Examples

use short_id::ShortId;

let id = ShortId::random();
let s: &str = id.as_str();
assert_eq!(s.len(), 14);

Examples found in repository

examples/newtype.rs (line 13)

fn main() {
    // Create a random ID
    let id1 = ShortId::random();
    println!("Random ID: {}", id1);

    // Create a time-ordered ID
    let id2 = ShortId::ordered();
    println!("Ordered ID: {}", id2);

    // Access as string slice
    let s: &str = id1.as_str();
    println!("As str: {}", s);

    // Use AsRef<str>
    print_id(&id2);

    // Convert to String
    let string: String = id1.clone().into_string();
    println!("Into String: {}", string);

    // Create from String
    let id3: ShortId = string.into();
    println!("From String: {}", id3);

    // Compare IDs (PartialEq, Ord)
    let id4 = ShortId::random();
    let id5 = ShortId::random();
    println!("\nIDs are equal: {}", id4 == id5);
    println!("ID4 < ID5: {}", id4 < id5);
}

examples/basic.rs (line 46)

fn main() {
    println!("=== Functions ===");

    // Generate a random ID using the function
    let random_id = short_id();
    println!("short_id():         {random_id}");

    // Generate a time-ordered ID using the function
    #[cfg(feature = "std")]
    {
        let ordered = short_id_ordered();
        println!("short_id_ordered(): {ordered}");
    }

    println!("\n=== Macros ===");

    // Generate IDs using macros (convenient shorthand)
    let macro_id = id!();
    println!("id!():              {macro_id}");

    #[cfg(feature = "std")]
    {
        let macro_ordered = ordered_id!();
        println!("ordered_id!():      {macro_ordered}");
    }

    println!("\n=== Typed Wrapper ===");

    // Generate IDs using the ShortId type
    let typed_random = ShortId::random();
    println!("ShortId::random():  {typed_random}");

    #[cfg(feature = "std")]
    {
        let typed_ordered = ShortId::ordered();
        println!("ShortId::ordered(): {typed_ordered}");
    }

    // Demonstrate type conversions
    let s: String = typed_random.clone().into();
    println!("\nConverted to String: {s}");
    println!("Using as_str():      {}", typed_random.as_str());
    println!("Using AsRef<str>:    {}", typed_random.as_ref());
}

pub fn into_string(self) -> String

Consumes the ShortId and returns the inner String.

Examples

use short_id::ShortId;

let id = ShortId::random();
let s: String = id.into_string();
assert_eq!(s.len(), 14);

Examples found in repository

examples/newtype.rs (line 20)

fn main() {
    // Create a random ID
    let id1 = ShortId::random();
    println!("Random ID: {}", id1);

    // Create a time-ordered ID
    let id2 = ShortId::ordered();
    println!("Ordered ID: {}", id2);

    // Access as string slice
    let s: &str = id1.as_str();
    println!("As str: {}", s);

    // Use AsRef<str>
    print_id(&id2);

    // Convert to String
    let string: String = id1.clone().into_string();
    println!("Into String: {}", string);

    // Create from String
    let id3: ShortId = string.into();
    println!("From String: {}", id3);

    // Compare IDs (PartialEq, Ord)
    let id4 = ShortId::random();
    let id5 = ShortId::random();
    println!("\nIDs are equal: {}", id4 == id5);
    println!("ID4 < ID5: {}", id4 < id5);
}

Trait Implementations

impl AsRef<str> for ShortId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ShortId

fn clone(&self) -> ShortId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShortId

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

Formats the value using the given formatter.

impl Display for ShortId

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

Formats the value using the given formatter.

impl From<ShortId> for String

fn from(id: ShortId) -> Self

Converts to this type from the input type.

impl From<String> for ShortId

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for ShortId

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 Ord for ShortId

fn cmp(&self, other: &ShortId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ShortId

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

fn partial_cmp(&self, other: &ShortId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ShortId

impl StructuralPartialEq for ShortId