std::str::FromStr - Rust
Description: API documentation for the Rust `FromStr` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, FromStr

# 1.0.0[−][src]Trait std::str::FromStr

    pub trait FromStr {
        type Err;
        fn from_str(s: &str) -> Result<Self, Self::Err>;
    }

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;
    use std::num::ParseIntError;

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

    impl FromStr for Point {
        type Err = ParseIntError;

        fn from_str(s: &str) -> Result<Self, Self::Err> {
            let coords: Vec<&str> = s.trim_matches(|p| p == '(' || p == ')' )
                                     .split(',')
                                     .collect();

            let x_fromstr = coords[0].parse::<i32>()?;
            let y_fromstr = coords[1].parse::<i32>()?;

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

    let p = Point::from_str("(1,2)");
    assert_eq!(p.unwrap(), Point{ x: 1, y: 2} )Run

## Associated Types

### `type Err`

The associated error which can be returned from parsing.

Loading content...

## Required methods

### `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 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

Loading content...

## Implementors

### `impl FromStr for IpAddr`[src]

#### `type Err = AddrParseError`

#### `fn from_str(s: &str) -> Result<IpAddr, AddrParseError>`[src]

### `impl FromStr for SocketAddr`[src]

#### `type Err = AddrParseError`

#### `fn from_str(s: &str) -> Result<SocketAddr, AddrParseError>`[src]

### `impl FromStr for bool`[src]

#### `type Err = ParseBoolError`

#### `fn from_str(s: &str) -> Result<bool, ParseBoolError>`[src]

Parse a `bool` from a string.

Yields a `Result<bool, ParseBoolError>`, because `s` may or may not actually be parseable.

# Examples

    use std::str::FromStr;

    assert_eq!(FromStr::from_str("true"), Ok(true));
    assert_eq!(FromStr::from_str("false"), Ok(false));
    assert!(<bool as FromStr>::from_str("not even a boolean").is_err());Run

Note, in many cases, the `.parse()` method on `str` is more proper.

    assert_eq!("true".parse(), Ok(true));
    assert_eq!("false".parse(), Ok(false));
    assert!("not even a boolean".parse::<bool>().is_err());Run

### `impl FromStr for char`[src]

#### `type Err = ParseCharError`

#### `fn from_str(s: &str) -> Result<char, <char as FromStr>::Err>`[src]

### `impl FromStr for f32`[src]

#### `type Err = ParseFloatError`

#### `fn from_str(src: &str) -> Result<f32, ParseFloatError>`[src]

Converts a string in base 10 to a float. Accepts an optional decimal exponent.

This function accepts strings such as

- '3.14'
- '-3.14'
- '2.5E10', or equivalently, '2.5e10'
- '2.5E-10'
- '5.'
- '.5', or, equivalently, '0.5'
- 'inf', '-inf', 'NaN'

Leading and trailing whitespace represent an error.

# Arguments

- src - A string

# Return value

`Err(ParseFloatError)` if the string did not represent a valid number. Otherwise, `Ok(n)` where `n` is the floating-point number represented by `src`.

### `impl FromStr for f64`[src]

#### `type Err = ParseFloatError`

#### `fn from_str(src: &str) -> Result<f64, ParseFloatError>`[src]

Converts a string in base 10 to a float. Accepts an optional decimal exponent.

This function accepts strings such as

- '3.14'
- '-3.14'
- '2.5E10', or equivalently, '2.5e10'
- '2.5E-10'
- '5.'
- '.5', or, equivalently, '0.5'
- 'inf', '-inf', 'NaN'

Leading and trailing whitespace represent an error.

# Arguments

- src - A string

# Return value

`Err(ParseFloatError)` if the string did not represent a valid number. Otherwise, `Ok(n)` where `n` is the floating-point number represented by `src`.

### `impl FromStr for i128`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<i128, ParseIntError>`[src]

### `impl FromStr for i16`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<i16, ParseIntError>`[src]

### `impl FromStr for i32`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<i32, ParseIntError>`[src]

### `impl FromStr for i64`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<i64, ParseIntError>`[src]

### `impl FromStr for i8`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<i8, ParseIntError>`[src]

### `impl FromStr for isize`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<isize, ParseIntError>`[src]

### `impl FromStr for u128`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<u128, ParseIntError>`[src]

### `impl FromStr for u16`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<u16, ParseIntError>`[src]

### `impl FromStr for u32`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<u32, ParseIntError>`[src]

### `impl FromStr for u64`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<u64, ParseIntError>`[src]

### `impl FromStr for u8`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<u8, ParseIntError>`[src]

### `impl FromStr for usize`[src]

#### `type Err = ParseIntError`

#### `fn from_str(src: &str) -> Result<usize, ParseIntError>`[src]

### `impl FromStr for Ipv4Addr`[src]

#### `type Err = AddrParseError`

#### `fn from_str(s: &str) -> Result<Ipv4Addr, AddrParseError>`[src]

### `impl FromStr for Ipv6Addr`[src]

#### `type Err = AddrParseError`

#### `fn from_str(s: &str) -> Result<Ipv6Addr, AddrParseError>`[src]

### `impl FromStr for SocketAddrV4`[src]

#### `type Err = AddrParseError`

#### `fn from_str(s: &str) -> Result<SocketAddrV4, AddrParseError>`[src]

### `impl FromStr for SocketAddrV6`[src]

#### `type Err = AddrParseError`

#### `fn from_str(s: &str) -> Result<SocketAddrV6, AddrParseError>`[src]

### `impl FromStr for PathBuf`[src]

#### `type Err = ParseError`

#### `fn from_str(s: &str) -> Result<Self, Self::Err>`[src]

### `impl FromStr for String`[src]

#### `type Err = ParseError`

#### `fn from_str(s: &str) -> Result<String, ParseError>`[src]

Loading content...

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)