FromStr

Trait FromStr 

1.0.0 (const: unstable) · Source
pub trait FromStr: Sized {
    type Err;

    // Required method
    fn from_str(s: &str) -> Result<Self, Self::Err>;
}
Expand description

Parse a value from a string

FromStr’s from_str method is often used implicitly, through str’s parse method. See parse’s documentation for examples.

FromStr does not have a lifetime parameter, and so you can only parse types that do not contain a lifetime parameter themselves. In other words, you can parse an i32 with FromStr, but not a &i32. You can parse a struct that contains an i32, but not one that contains an &i32.

§Input format and round-tripping

The input format expected by a type’s FromStr implementation depends on the type. Check the type’s documentation for the input formats it knows how to parse. Note that the input format of a type’s FromStr implementation might not necessarily accept the output format of its Display implementation, and even if it does, the Display implementation may not be lossless so the round-trip may lose information.

However, if a type has a lossless Display implementation whose output is meant to be conveniently machine-parseable and not just meant for human consumption, then the type may wish to accept the same format in FromStr, and document that usage. Having both Display and FromStr implementations where the result of Display cannot be parsed with FromStr may surprise users.

§Examples

Basic implementation of FromStr on an example Point type:

use std::str::FromStr;

#[derive(Debug, PartialEq)]
struct Point {
    x: i32,
    y: i32
}

#[derive(Debug, PartialEq, Eq)]
struct ParsePointError;

impl FromStr for Point {
    type Err = ParsePointError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let (x, y) = s
            .strip_prefix('(')
            .and_then(|s| s.strip_suffix(')'))
            .and_then(|s| s.split_once(','))
            .ok_or(ParsePointError)?;

        let x_fromstr = x.parse::<i32>().map_err(|_| ParsePointError)?;
        let y_fromstr = y.parse::<i32>().map_err(|_| ParsePointError)?;

        Ok(Point { x: x_fromstr, y: y_fromstr })
    }
}

let expected = Ok(Point { x: 1, y: 2 });
// Explicit call
assert_eq!(Point::from_str("(1,2)"), expected);
// Implicit calls, through parse
assert_eq!("(1,2)".parse(), expected);
assert_eq!("(1,2)".parse::<Point>(), expected);
// Invalid input string
assert!(Point::from_str("(1 2)").is_err());

Required Associated Types§

1.0.0 · Source

type Err

The associated error which can be returned from parsing.

Required Methods§

1.0.0 · Source

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

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

If parsing succeeds, return the value inside Ok, otherwise when the string is ill-formatted return an error specific to the inside Err. The error type is specific to the implementation of the trait.

§Examples

Basic usage with i32, a type that implements FromStr:

use std::str::FromStr;

let s = "5";
let x = i32::from_str(s).unwrap();

assert_eq!(5, x);

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

1.7.0 · Source§

impl FromStr for IpAddr

1.0.0 · Source§

impl FromStr for SocketAddr

Source§

impl FromStr for chrono::month::Month

Parsing a str into a Month uses the format %B.

§Example

use chrono::Month;

assert_eq!("January".parse::<Month>(), Ok(Month::January));
assert!("any day".parse::<Month>().is_err());

The parsing is case-insensitive.

assert_eq!("fEbruARy".parse::<Month>(), Ok(Month::February));

Only the shortest form (e.g. jan) and the longest form (e.g. january) is accepted.

assert!("septem".parse::<Month>().is_err());
assert!("Augustin".parse::<Month>().is_err());
Source§

impl FromStr for chrono::weekday::Weekday

Parsing a str into a Weekday uses the format %A.

§Example

use chrono::Weekday;

assert_eq!("Sunday".parse::<Weekday>(), Ok(Weekday::Sun));
assert!("any day".parse::<Weekday>().is_err());

The parsing is case-insensitive.

assert_eq!("mON".parse::<Weekday>(), Ok(Weekday::Mon));

Only the shortest form (e.g. sun) and the longest form (e.g. sunday) is accepted.

assert!("thurs".parse::<Weekday>().is_err());
Source§

impl FromStr for Icrc21Function

Source§

impl FromStr for time::month::Month

Source§

impl FromStr for time::weekday::Weekday

1.0.0 · Source§

impl FromStr for bool

1.20.0 · Source§

impl FromStr for char

1.0.0 · Source§

impl FromStr for f16

1.0.0 · Source§

impl FromStr for f32

1.0.0 · Source§

impl FromStr for f64

1.0.0 (const: unstable) · Source§

impl FromStr for i8

1.0.0 (const: unstable) · Source§

impl FromStr for i16

1.0.0 (const: unstable) · Source§

impl FromStr for i32

1.0.0 (const: unstable) · Source§

impl FromStr for i64

1.0.0 (const: unstable) · Source§

impl FromStr for i128

1.0.0 (const: unstable) · Source§

impl FromStr for isize

1.0.0 (const: unstable) · Source§

impl FromStr for u8

1.0.0 (const: unstable) · Source§

impl FromStr for u16

1.0.0 (const: unstable) · Source§

impl FromStr for u32

1.0.0 (const: unstable) · Source§

impl FromStr for u64

1.0.0 (const: unstable) · Source§

impl FromStr for u128

1.0.0 (const: unstable) · Source§

impl FromStr for usize

Source§

impl FromStr for icydb_core::types::Account

Source§

impl FromStr for Date

Source§

type Err = <i32 as FromStr>::Err

Source§

impl FromStr for icydb_core::types::Decimal

Source§

impl FromStr for Duration

Source§

type Err = <u64 as FromStr>::Err

Source§

impl FromStr for E8s

Source§

type Err = <u64 as FromStr>::Err

Source§

impl FromStr for E18s

Source§

impl FromStr for Int128

Source§

impl FromStr for icydb_core::types::Int

Source§

type Err = <Int as FromStr>::Err

Source§

impl FromStr for Nat128

Source§

impl FromStr for icydb_core::types::Nat

Source§

type Err = <Nat as FromStr>::Err

Source§

impl FromStr for icydb_core::types::Principal

Source§

impl FromStr for Timestamp

Source§

type Err = <u64 as FromStr>::Err

Source§

impl FromStr for icydb_core::types::Ulid

Source§

impl FromStr for ByteString

1.85.0 · Source§

impl FromStr for CString

1.0.0 · Source§

impl FromStr for String

Available on non-no_global_oom_handling only.
1.0.0 · Source§

impl FromStr for Ipv4Addr

1.0.0 · Source§

impl FromStr for Ipv6Addr

1.5.0 · Source§

impl FromStr for SocketAddrV4

1.5.0 · Source§

impl FromStr for SocketAddrV6

1.35.0 · Source§

impl FromStr for NonZero<i8>

1.35.0 · Source§

impl FromStr for NonZero<i16>

1.35.0 · Source§

impl FromStr for NonZero<i32>

1.35.0 · Source§

impl FromStr for NonZero<i64>

1.35.0 · Source§

impl FromStr for NonZero<i128>

1.35.0 · Source§

impl FromStr for NonZero<isize>

1.35.0 · Source§

impl FromStr for NonZero<u8>

1.35.0 · Source§

impl FromStr for NonZero<u16>

1.35.0 · Source§

impl FromStr for NonZero<u32>

1.35.0 · Source§

impl FromStr for NonZero<u64>

1.35.0 · Source§

impl FromStr for NonZero<u128>

1.35.0 · Source§

impl FromStr for NonZero<usize>

1.45.0 · Source§

impl FromStr for OsString

1.32.0 · Source§

impl FromStr for PathBuf

Source§

impl FromStr for candid::types::number::Int

Source§

impl FromStr for candid::types::number::Nat

Source§

impl FromStr for canic_cdk::types::account::Account

Source§

impl FromStr for Cycles

Source§

impl FromStr for canic_types::decimal::Decimal

Source§

impl FromStr for DateTime<FixedOffset>

Accepts a relaxed form of RFC3339. A space or a ‘T’ are accepted as the separator between the date and time parts. Additional spaces are allowed between each component.

All of these examples are equivalent:

"2012-12-12T12:12:12Z".parse::<DateTime<FixedOffset>>()?;
"2012-12-12 12:12:12Z".parse::<DateTime<FixedOffset>>()?;
"2012-  12-12T12:  12:12Z".parse::<DateTime<FixedOffset>>()?;
Source§

impl FromStr for DateTime<Utc>

Accepts a relaxed form of RFC3339. A space or a ‘T’ are accepted as the separator between the date and time parts.

All of these examples are equivalent:

"2012-12-12T12:12:12Z".parse::<DateTime<Utc>>()?;
"2012-12-12 12:12:12Z".parse::<DateTime<Utc>>()?;
"2012-12-12 12:12:12+0000".parse::<DateTime<Utc>>()?;
"2012-12-12 12:12:12+00:00".parse::<DateTime<Utc>>()?;
Source§

impl FromStr for NaiveDate

Parsing a str into a NaiveDate uses the same format, %Y-%m-%d, as in Debug and Display.

§Example

use chrono::NaiveDate;

let d = NaiveDate::from_ymd_opt(2015, 9, 18).unwrap();
assert_eq!("2015-09-18".parse::<NaiveDate>(), Ok(d));

let d = NaiveDate::from_ymd_opt(12345, 6, 7).unwrap();
assert_eq!("+12345-6-7".parse::<NaiveDate>(), Ok(d));

assert!("foo".parse::<NaiveDate>().is_err());
Source§

impl FromStr for NaiveDateTime

Parsing a str into a NaiveDateTime uses the same format, %Y-%m-%dT%H:%M:%S%.f, as in Debug.

§Example

use chrono::{NaiveDateTime, NaiveDate};

let dt = NaiveDate::from_ymd_opt(2015, 9, 18).unwrap().and_hms_opt(23, 56, 4).unwrap();
assert_eq!("2015-09-18T23:56:04".parse::<NaiveDateTime>(), Ok(dt));

let dt = NaiveDate::from_ymd_opt(12345, 6, 7).unwrap().and_hms_milli_opt(7, 59, 59, 1_500).unwrap(); // leap second
assert_eq!("+12345-6-7T7:59:60.5".parse::<NaiveDateTime>(), Ok(dt));

assert!("foo".parse::<NaiveDateTime>().is_err());
Source§

impl FromStr for NaiveTime

Parsing a str into a NaiveTime uses the same format, %H:%M:%S%.f, as in Debug and Display.

§Example

use chrono::NaiveTime;

let t = NaiveTime::from_hms_opt(23, 56, 4).unwrap();
assert_eq!("23:56:04".parse::<NaiveTime>(), Ok(t));

let t = NaiveTime::from_hms_nano_opt(23, 56, 4, 12_345_678).unwrap();
assert_eq!("23:56:4.012345678".parse::<NaiveTime>(), Ok(t));

let t = NaiveTime::from_hms_nano_opt(23, 59, 59, 1_234_567_890).unwrap(); // leap second
assert_eq!("23:59:60.23456789".parse::<NaiveTime>(), Ok(t));

// Seconds are optional
let t = NaiveTime::from_hms_opt(23, 56, 0).unwrap();
assert_eq!("23:56".parse::<NaiveTime>(), Ok(t));

assert!("foo".parse::<NaiveTime>().is_err());
Source§

impl FromStr for FixedOffset

Parsing a str into a FixedOffset uses the format %z.

Source§

impl FromStr for bf16

Source§

impl FromStr for f16

Source§

impl FromStr for ic_principal::Principal

Available on crate feature convert only.
Source§

impl FromStr for icrc_ledger_types::icrc1::account::Account

Source§

impl FromStr for BigInt

Source§

impl FromStr for BigUint

Source§

impl FromStr for rust_decimal::decimal::Decimal

Source§

impl FromStr for ulid::Ulid

Source§

impl<A> FromStr for arrayvec::array_string::ArrayString<A>
where A: Array<Item = u8> + Copy,

Source§

impl<const CAP: usize> FromStr for arrayvec::array_string::ArrayString<CAP>

Source§

impl<const MIN: i8, const MAX: i8> FromStr for RangedI8<MIN, MAX>

Source§

impl<const MIN: i16, const MAX: i16> FromStr for RangedI16<MIN, MAX>

Source§

impl<const MIN: i32, const MAX: i32> FromStr for RangedI32<MIN, MAX>

Source§

impl<const MIN: i64, const MAX: i64> FromStr for RangedI64<MIN, MAX>

Source§

impl<const MIN: i128, const MAX: i128> FromStr for RangedI128<MIN, MAX>

Source§

impl<const MIN: isize, const MAX: isize> FromStr for RangedIsize<MIN, MAX>

Source§

impl<const MIN: u8, const MAX: u8> FromStr for RangedU8<MIN, MAX>

Source§

impl<const MIN: u16, const MAX: u16> FromStr for RangedU16<MIN, MAX>

Source§

impl<const MIN: u32, const MAX: u32> FromStr for RangedU32<MIN, MAX>

Source§

impl<const MIN: u64, const MAX: u64> FromStr for RangedU64<MIN, MAX>

Source§

impl<const MIN: u128, const MAX: u128> FromStr for RangedU128<MIN, MAX>

Source§

impl<const MIN: usize, const MAX: usize> FromStr for RangedUsize<MIN, MAX>