Trait core::str::FromStr

1.0.0 · 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.

§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());
Run

Required Associated Types§

source

type Err

The associated error which can be returned from parsing.

Required Methods§

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);
Run

Object Safety§

This trait is not object safe.

Implementors§

1.7.0 · source§

impl FromStr for IpAddr

source§

impl FromStr for SocketAddr

source§

impl FromStr for bool

1.20.0 · source§

impl FromStr for char

source§

impl FromStr for f32

source§

impl FromStr for f64

source§

impl FromStr for i8

source§

impl FromStr for i16

source§

impl FromStr for i32

source§

impl FromStr for i64

source§

impl FromStr for i128

source§

impl FromStr for isize

source§

impl FromStr for u8

source§

impl FromStr for u16

source§

impl FromStr for u32

source§

impl FromStr for u64

source§

impl FromStr for u128

source§

impl FromStr for usize

source§

impl FromStr for Ipv4Addr

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 NonZeroI8

1.35.0 · source§

impl FromStr for NonZeroI16

1.35.0 · source§

impl FromStr for NonZeroI32

1.35.0 · source§

impl FromStr for NonZeroI64

1.35.0 · source§

impl FromStr for NonZeroI128

1.35.0 · source§

impl FromStr for NonZeroIsize

1.35.0 · source§

impl FromStr for NonZeroU8

1.35.0 · source§

impl FromStr for NonZeroU16

1.35.0 · source§

impl FromStr for NonZeroU32

1.35.0 · source§

impl FromStr for NonZeroU64

1.35.0 · source§

impl FromStr for NonZeroU128

1.35.0 · source§

impl FromStr for NonZeroUsize