Skip to content

Commit fcda7b2

Browse files
committed
Add doc for impl From for Std Error
1 parent 6bf6d50 commit fcda7b2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/libstd/error.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,20 +152,24 @@ pub trait Error: Debug + Display {
152152

153153
#[stable(feature = "rust1", since = "1.0.0")]
154154
impl<'a, E: Error + 'a> From<E> for Box<dyn Error + 'a> {
155+
/// Converts a type of [`Error`] into a box of dyn [`Error`].
155156
fn from(err: E) -> Box<dyn Error + 'a> {
156157
Box::new(err)
157158
}
158159
}
159160

160161
#[stable(feature = "rust1", since = "1.0.0")]
161162
impl<'a, E: Error + Send + Sync + 'a> From<E> for Box<dyn Error + Send + Sync + 'a> {
163+
/// Converts a type of [`Error`] + [`Send`] + [`Sync`] into a box of dyn [`Error`] +
164+
/// [`Send`] + [`Sync`].
162165
fn from(err: E) -> Box<dyn Error + Send + Sync + 'a> {
163166
Box::new(err)
164167
}
165168
}
166169

167170
#[stable(feature = "rust1", since = "1.0.0")]
168171
impl From<String> for Box<dyn Error + Send + Sync> {
172+
/// Converts a [`String`] into a box of dyn [`Error`] + [`Send`] + [`Sync`].
169173
fn from(err: String) -> Box<dyn Error + Send + Sync> {
170174
#[derive(Debug)]
171175
struct StringError(String);
@@ -186,6 +190,7 @@ impl From<String> for Box<dyn Error + Send + Sync> {
186190

187191
#[stable(feature = "string_box_error", since = "1.6.0")]
188192
impl From<String> for Box<dyn Error> {
193+
/// Converts a [`String`] into a box of dyn [`Error`].
189194
fn from(str_err: String) -> Box<dyn Error> {
190195
let err1: Box<dyn Error + Send + Sync> = From::from(str_err);
191196
let err2: Box<dyn Error> = err1;
@@ -195,27 +200,31 @@ impl From<String> for Box<dyn Error> {
195200

196201
#[stable(feature = "rust1", since = "1.0.0")]
197202
impl<'a, 'b> From<&'b str> for Box<dyn Error + Send + Sync + 'a> {
203+
/// Converts a [`str`] into a box of dyn [`Error`] + [`Send`] + [`Sync`].
198204
fn from(err: &'b str) -> Box<dyn Error + Send + Sync + 'a> {
199205
From::from(String::from(err))
200206
}
201207
}
202208

203209
#[stable(feature = "string_box_error", since = "1.6.0")]
204210
impl<'a> From<&'a str> for Box<dyn Error> {
211+
/// Converts a [`str`] into a box of dyn [`Error`].
205212
fn from(err: &'a str) -> Box<dyn Error> {
206213
From::from(String::from(err))
207214
}
208215
}
209216

210217
#[stable(feature = "cow_box_error", since = "1.22.0")]
211218
impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Send + Sync + 'a> {
219+
/// Converts a [`Cow`] into a box of dyn [`Error`] + [`Send`] + [`Sync`].
212220
fn from(err: Cow<'b, str>) -> Box<dyn Error + Send + Sync + 'a> {
213221
From::from(String::from(err))
214222
}
215223
}
216224

217225
#[stable(feature = "cow_box_error", since = "1.22.0")]
218226
impl<'a> From<Cow<'a, str>> for Box<dyn Error> {
227+
/// Converts a [`Cow`] into a box of dyn [`Error`].
219228
fn from(err: Cow<'a, str>) -> Box<dyn Error> {
220229
From::from(String::from(err))
221230
}

0 commit comments

Comments
 (0)