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

𝐓 core Parse a value from a string.

Re-exported from core::str:: .


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§

§

impl FromStr for Color

§

type Err = ()

§

impl FromStr for Pixel

§

impl FromStr for Item

§

impl FromStr for Value

1.7.0 · Source§

impl FromStr for IpAddr

Source§

impl FromStr for Level

Source§

impl FromStr for LevelFilter

Source§

impl FromStr for Month

Returns a Month from a string containing either the full month name, or any of the month ASCII abbreviations.

Source§

type Err = &'static str

1.0.0 · Source§

impl FromStr for SocketAddr

Source§

impl FromStr for Weekday

Returns a Weekday from a string containing either the full weekday name, or any of the weekday ASCII abbreviations.

Source§

type Err = &'static str

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 ByteString

§

impl FromStr for Date

§

type Err = Error

§

impl FromStr for DateTime

§

type Err = Error

§

impl FromStr for Time

§

type Err = Error

§

impl FromStr for SignedDuration

§

type Err = Error

§

impl FromStr for Span

§

type Err = Error

§

impl FromStr for Timestamp

§

type Err = Error

§

impl FromStr for Zoned

Parses a zoned timestamp from the Temporal datetime format.

See the fmt::temporal for more information on the precise format.

Note that this is only enabled when the std feature is enabled because it requires access to a global TimeZoneDatabase.

§

type Err = Error

§

impl FromStr for Regex

§

type Err = Error

§

impl FromStr for Gid

§

type Err = <u32 as FromStr>::Err

§

impl FromStr for IpNetwork

§

impl FromStr for MacAddr

§

impl FromStr for Pid

§

type Err = <i32 as FromStr>::Err

§

impl FromStr for Uid

§

type Err = <u32 as FromStr>::Err

§

impl FromStr for Deserializer

§

type Err = Error

§

impl FromStr for ValueDeserializer

§

type Err = Error

§

impl FromStr for Datetime

§

impl FromStr for Document<String>

§

impl FromStr for DocumentMut

§

impl FromStr for Key

§

impl FromStr for HeaderName

§

impl FromStr for HeaderValue

§

impl FromStr for Method

§

impl FromStr for StatusCode

§

impl FromStr for Uri

§

impl FromStr for Authority

§

impl FromStr for PathAndQuery

§

impl FromStr for Scheme

Source§

impl FromStr for BigInt

Source§

impl FromStr for BigUint

Source§

impl FromStr for Braced

Source§

impl FromStr for Hyphenated

Source§

impl FromStr for Simple

Source§

impl FromStr for Urn

Source§

impl FromStr for Uuid

1.85.0 · Source§

impl FromStr for CString

1.0.0 · Source§

impl FromStr for Ipv4Addr

1.0.0 · Source§

impl FromStr for Ipv6Addr

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

1.5.0 · Source§

impl FromStr for SocketAddrV4

1.5.0 · Source§

impl FromStr for SocketAddrV6

1.0.0 · Source§

impl FromStr for String

§

impl FromStr for Addr

§

type Err = Box<dyn Error>

§

impl FromStr for Format

Source§

impl<T> FromStr for Ratio<T>
where T: FromStr + Clone + Integer,

Source§

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

Source§

impl<const V: i8> FromStr for NonValueI8<V>

Source§

impl<const V: i16> FromStr for NonValueI16<V>

Source§

impl<const V: i32> FromStr for NonValueI32<V>

Source§

impl<const V: i64> FromStr for NonValueI64<V>

Source§

impl<const V: i128> FromStr for NonValueI128<V>

Source§

impl<const V: isize> FromStr for NonValueIsize<V>

Source§

impl<const V: u8> FromStr for NonValueU8<V>

Source§

impl<const V: u16> FromStr for NonValueU16<V>

Source§

impl<const V: u32> FromStr for NonValueU32<V>

Source§

impl<const V: u64> FromStr for NonValueU64<V>

Source§

impl<const V: u128> FromStr for NonValueU128<V>

Source§

impl<const V: usize> FromStr for NonValueUsize<V>