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§

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

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 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 IpNet

source§

impl FromStr for log::Level

source§

impl FromStr for log::LevelFilter

source§

impl FromStr for Value

§

type Err = Error

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

§

impl FromStr for AssetPackReq

§

type Err = String

§

impl FromStr for SchemaPath

§

type Err = String

§

impl FromStr for Ulid

§

type Err = DecodeError

source§

impl FromStr for Version

§

type Err = Error

§

impl FromStr for LabeledId

§

impl FromStr for Ustr

source§

impl FromStr for bones_framework::asset::prelude::bones_utils::prelude::alloc::string::String

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

1.45.0 · source§

impl FromStr for OsString

1.32.0 · source§

impl FromStr for PathBuf

source§

impl FromStr for chrono::datetime::DateTime<FixedOffset>

Accepts a relaxed form of RFC3339. A space or a ‘T’ are acepted 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 chrono::datetime::DateTime<Local>

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<Local>>()?;
"2012-12-12 12:12:12Z".parse::<DateTime<Local>>()?;
"2012-12-12 12:12:12+0000".parse::<DateTime<Local>>()?;
"2012-12-12 12:12:12+00:00".parse::<DateTime<Local>>()?;
source§

impl FromStr for chrono::datetime::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 http::header::name::HeaderName

source§

impl FromStr for http::header::value::HeaderValue

source§

impl FromStr for http::method::Method

source§

impl FromStr for http::status::StatusCode

source§

impl FromStr for http::uri::authority::Authority

source§

impl FromStr for http::uri::path::PathAndQuery

source§

impl FromStr for http::uri::scheme::Scheme

source§

impl FromStr for http::uri::Uri

source§

impl FromStr for Ipv4Net

source§

impl FromStr for Ipv6Net

source§

impl FromStr for Mime

source§

impl FromStr for BigInt

source§

impl FromStr for BigUint

source§

impl FromStr for BuildMetadata

§

type Err = Error

source§

impl FromStr for Comparator

§

type Err = Error

source§

impl FromStr for Prerelease

§

type Err = Error

source§

impl FromStr for VersionReq

§

type Err = Error

source§

impl FromStr for serde_json::number::Number

§

type Err = Error

source§

impl FromStr for serde_yaml::number::Number

§

type Err = Error

source§

impl FromStr for Url

Parse a string as an URL, without a base URL or encoding override.

§

impl FromStr for A

§

impl FromStr for AAAA

§

impl FromStr for Addr

§

type Err = Box<dyn Error>

§

impl FromStr for AddrInfoOptions

§

type Err = FromStrError

§

impl FromStr for Algorithm

§

type Err = LabelError

§

impl FromStr for AlgorithmName

§

type Err = LabelError

§

impl FromStr for Authority

§

type Err = InvalidUri

§

impl FromStr for BlobTicket

§

type Err = Error

§

impl FromStr for BmpString

§

type Err = Error

§

impl FromStr for Certificate

§

type Err = Error

§

impl FromStr for Cipher

§

type Err = LabelError

§

impl FromStr for ClientSubnet

§

impl FromStr for Color

§

type Err = ParseColorError

§

impl FromStr for ConfigOpts

§

type Err = Error

§

impl FromStr for DNSClass

§

type Err = ProtoError

§

impl FromStr for DateTime

§

type Err = Error

§

impl FromStr for Duration

§

type Err = Error

§

impl FromStr for EcdsaCurve

§

type Err = LabelError

§

impl FromStr for Encoding

§

type Err = &'static str

§

impl FromStr for Entry

§

type Err = Error

§

impl FromStr for Entry

§

type Err = Error

§

impl FromStr for Fingerprint

§

type Err = Error

§

impl FromStr for FluentNumber

§

impl FromStr for Format

§

impl FromStr for Hash

§

type Err = HexOrBase32ParseError

§

impl FromStr for Hash

§

type Err = HexError

§

impl FromStr for HashAlg

§

type Err = LabelError

§

impl FromStr for HashAndFormat

§

type Err = Error

§

impl FromStr for Header

§

type Err = Error

§

impl FromStr for HeaderName

§

type Err = InvalidHeaderName

§

impl FromStr for HeaderValue

§

type Err = InvalidHeaderValue

§

impl FromStr for HostPatterns

§

type Err = Error

§

impl FromStr for HttpDate

§

type Err = Error

§

impl FromStr for IrohAttr

§

type Err = ParseError

§

impl FromStr for KdfAlg

§

type Err = LabelError

§

impl FromStr for Language

§

type Err = ParserError

§

impl FromStr for LanguageIdentifier

§

type Err = LanguageIdentifierError

§

impl FromStr for Level

§

type Err = ParseLevelError

§

impl FromStr for LevelFilter

§

type Err = ParseLevelFilterError

§

impl FromStr for LowerName

§

type Err = ProtoError

§

impl FromStr for MacAddr

§

type Err = ParseMacAddrError

§

impl FromStr for MacAddr

§

type Err = ParseMacAddrErr

§

impl FromStr for Marker

§

type Err = Error

§

impl FromStr for Method

§

type Err = InvalidMethod

§

impl FromStr for Month

§

type Err = InvalidVariant

§

impl FromStr for Name

§

type Err = InvalidNameError

§

impl FromStr for Name

§

type Err = ProtoError

§

impl FromStr for NodeTicket

§

type Err = Error

§

impl FromStr for ObjectIdentifier

§

type Err = ParseOidError

§

impl FromStr for OwnedName

§

type Err = ()

§

impl FromStr for PathAndQuery

§

type Err = InvalidUri

§

impl FromStr for Pem

§

type Err = PemError

§

impl FromStr for PrivateKey

§

type Err = Error

§

impl FromStr for PublicKey

Deserialises the [PublicKey] from it’s base32 encoding.

Display is capable of serialising this format.

§

type Err = KeyParsingError

§

impl FromStr for PublicKey

§

type Err = Error

§

impl FromStr for RecordType

§

type Err = ProtoError

§

impl FromStr for Region

§

type Err = ParserError

§

impl FromStr for RelayUrl

This is a convenience only to directly parse strings.

If you need more control over the error first create a Url and use [RelayUrl::from] instead.

§

type Err = Error

§

impl FromStr for Response

§

type Err = Error

§

impl FromStr for Scheme

§

type Err = InvalidUri

§

impl FromStr for ScopedIp

§

type Err = AddrParseError

§

impl FromStr for Script

§

type Err = ParserError

§

impl FromStr for SecretKey

§

type Err = KeyParsingError

§

impl FromStr for Signal

§

type Err = Errno

§

impl FromStr for Signature

Decode a signature from hexadecimal.

Upper and lower case hexadecimal are both accepted, however mixed case is rejected.

§

type Err = Error

§

impl FromStr for SshSig

§

type Err = Error

§

impl FromStr for StatusCode

§

type Err = InvalidStatusCode

§

impl FromStr for SvcParamKey

§

type Err = ProtoError

§

impl FromStr for TagMode

§

type Err = Error

§

impl FromStr for Timestamp

§

type Err = Error

§

impl FromStr for Uri

§

type Err = InvalidUri

§

impl FromStr for Variant

§

type Err = ParserError

§

impl FromStr for Weekday

§

type Err = InvalidVariant

§

impl<'a> FromStr for Oid<'a>

§

type Err = OidParseError

§

impl<'a> FromStr for Oid<'a>

§

type Err = OidParseError

§

impl<Size> FromStr for EncodedPoint<Size>where Size: ModulusSize,

Decode a SEC1-encoded point from hexadecimal.

Upper and lower case hexadecimal are both accepted, however mixed case is rejected.

§

type Err = Error

§

impl<T> FromStr for MaybeOwned<'_, T>where T: FromStr,

§

type Err = <T as FromStr>::Err

§

impl<T> FromStr for MaybeOwnedMut<'_, T>where T: FromStr,

§

type Err = <T as FromStr>::Err

source§

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

source§

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

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

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

§

type Err = ParseIntError

§

impl<const N: usize> FromStr for String<N>

§

type Err = ()

§

impl<const N: usize> FromStr for TinyAsciiStr<N>

§

type Err = TinyStrError