Trait parsel::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());

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

Object Safety§

This trait is not object safe.

Implementors§

source§

impl FromStr for Lit

§

type Err = Error

1.7.0 · source§

impl FromStr for IpAddr

1.0.0 · source§

impl FromStr for SocketAddr

1.0.0 · source§

impl FromStr for bool

1.20.0 · source§

impl FromStr for char

1.0.0 · source§

impl FromStr for f32

1.0.0 · source§

impl FromStr for f64

1.0.0 · source§

impl FromStr for i8

1.0.0 · source§

impl FromStr for i16

1.0.0 · source§

impl FromStr for i32

1.0.0 · source§

impl FromStr for i64

1.0.0 · source§

impl FromStr for i128

1.0.0 · source§

impl FromStr for isize

1.0.0 · source§

impl FromStr for u8

1.0.0 · source§

impl FromStr for u16

1.0.0 · source§

impl FromStr for u32

1.0.0 · source§

impl FromStr for u64

1.0.0 · source§

impl FromStr for u128

1.0.0 · source§

impl FromStr for usize

source§

impl FromStr for Empty

§

type Err = Error

source§

impl FromStr for Eof

§

type Err = Error

source§

impl FromStr for LitBool

§

type Err = Error

source§

impl FromStr for LitByte

§

type Err = Error

source§

impl FromStr for LitByteStr

§

type Err = Error

source§

impl FromStr for LitChar

§

type Err = Error

source§

impl FromStr for LitFloat

§

type Err = Error

source§

impl FromStr for LitInt

§

type Err = Error

source§

impl FromStr for LitStr

§

type Err = Error

source§

impl FromStr for LitUint

§

type Err = Error

source§

impl FromStr for NotEof

§

type Err = Error

1.0.0 · source§

impl FromStr for String

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.54.0 · source§

impl FromStr for proc_macro::Literal

Parse a single literal from its stringified representation.

In order to parse successfully, the input string must not contain anything but the literal token. Specifically, it must not contain whitespace or comments in addition to the literal.

The resulting literal token will have a Span::call_site() span.

NOTE: some errors may cause panics instead of returning LexError. We reserve the right to change these errors into LexErrors later.

1.15.0 · source§

impl FromStr for proc_macro::TokenStream

Attempts to break the string into tokens and parse those tokens into a token stream. May fail for a number of reasons, for example, if the string contains unbalanced delimiters or characters not existing in the language. All tokens in the parsed stream get Span::call_site() spans.

NOTE: some errors may cause panics instead of returning LexError. We reserve the right to change these errors into LexErrors later.

1.45.0 · source§

impl FromStr for OsString

1.32.0 · source§

impl FromStr for PathBuf

source§

impl FromStr for proc_macro2::Literal

source§

impl FromStr for parsel::TokenStream

Attempts to break the string into tokens and parse those tokens into a token stream.

May fail for a number of reasons, for example, if the string contains unbalanced delimiters or characters not existing in the language.

NOTE: Some errors may cause panics instead of returning LexError. We reserve the right to change these errors into LexErrors later.

source§

impl<K> FromStr for CustomIdent<K>
where K: Default + KeywordList,

§

type Err = Error

source§

impl<L, R> FromStr for Either<L, R>
where L: Parse, R: Parse,

§

type Err = Error

source§

impl<O, L> FromStr for RightAssoc<O, L>
where O: Parse, L: Parse,

§

type Err = Error

source§

impl<O, R> FromStr for LeftAssoc<O, R>
where O: Parse, R: Parse,

§

type Err = Error

source§

impl<P, T> FromStr for Maybe<P, T>
where P: Parse, T: Parse,

§

type Err = Error

source§

impl<T> FromStr for Any<T>
where T: Parse,

§

type Err = Error

source§

impl<T> FromStr for OrderedFloat<T>
where T: FromStr,

§

type Err = <T as FromStr>::Err

source§

impl<T> FromStr for NotNan<T>
where T: FloatCore + FromStr,

source§

impl<T, P> FromStr for Punctuated<T, P>
where T: Parse, P: Parse,

§

type Err = Error

source§

impl<T, P> FromStr for Separated<T, P>
where T: Parse, P: Parse,

§

type Err = Error

source§

impl<T: Parse> FromStr for Brace<T>

§

type Err = Error

source§

impl<T: Parse> FromStr for Bracket<T>

§

type Err = Error

source§

impl<T: Parse> FromStr for Paren<T>

§

type Err = Error