Rollup merge of #40824 - donniebishop:fromstr_docexample, r=steveklabnik
FromStr implementation example Referencing #29375. Added example implementation of FromStr trait to API Documentation
This commit is contained in:
commit
6b2c4bf22b
@ -35,6 +35,39 @@ pub mod pattern;
|
|||||||
/// [`from_str`]: #tymethod.from_str
|
/// [`from_str`]: #tymethod.from_str
|
||||||
/// [`str`]: ../../std/primitive.str.html
|
/// [`str`]: ../../std/primitive.str.html
|
||||||
/// [`parse`]: ../../std/primitive.str.html#method.parse
|
/// [`parse`]: ../../std/primitive.str.html#method.parse
|
||||||
|
///
|
||||||
|
/// # 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} )
|
||||||
|
/// ```
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
pub trait FromStr: Sized {
|
pub trait FromStr: Sized {
|
||||||
/// The associated error which can be returned from parsing.
|
/// The associated error which can be returned from parsing.
|
||||||
|
Loading…
Reference in New Issue
Block a user