Skip to content

Make iterator struct docs more consistent. #24627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2015
Merged

Make iterator struct docs more consistent. #24627

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions src/libcore/str/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ impl<'a> DoubleEndedIterator for CharIndices<'a> {
/// External iterator for a string's bytes.
/// Use with the `std::iter` module.
///
/// Created with `str::bytes`
/// Created with the method `.bytes()`.
#[stable(feature = "rust1", since = "1.0.0")]
#[derive(Clone)]
pub struct Bytes<'a>(Map<slice::Iter<'a, u8>, BytesDeref>);
Expand Down Expand Up @@ -636,10 +636,10 @@ impl<'a, P: Pattern<'a>> SplitInternal<'a, P> {

generate_pattern_iterators! {
forward:
/// Return type of `str::split()`
/// Created with the method `.split()`.
struct Split;
reverse:
/// Return type of `str::rsplit()`
/// Created with the method `.rsplit()`.
struct RSplit;
stability:
#[stable(feature = "rust1", since = "1.0.0")]
Expand All @@ -650,10 +650,10 @@ generate_pattern_iterators! {

generate_pattern_iterators! {
forward:
/// Return type of `str::split_terminator()`
/// Created with the method `.split_terminator()`.
struct SplitTerminator;
reverse:
/// Return type of `str::rsplit_terminator()`
/// Created with the method `.rsplit_terminator()`.
struct RSplitTerminator;
stability:
#[stable(feature = "rust1", since = "1.0.0")]
Expand Down Expand Up @@ -696,10 +696,10 @@ impl<'a, P: Pattern<'a>> SplitNInternal<'a, P> {

generate_pattern_iterators! {
forward:
/// Return type of `str::splitn()`
/// Created with the method `.splitn()`.
struct SplitN;
reverse:
/// Return type of `str::rsplitn()`
/// Created with the method `.rsplitn()`.
struct RSplitN;
stability:
#[stable(feature = "rust1", since = "1.0.0")]
Expand Down Expand Up @@ -730,10 +730,10 @@ impl<'a, P: Pattern<'a>> MatchIndicesInternal<'a, P> {

generate_pattern_iterators! {
forward:
/// Return type of `str::match_indices()`
/// Created with the method `.match_indices()`.
struct MatchIndices;
reverse:
/// Return type of `str::rmatch_indices()`
/// Created with the method `.rmatch_indices()`.
struct RMatchIndices;
stability:
#[unstable(feature = "core",
Expand Down Expand Up @@ -771,10 +771,10 @@ impl<'a, P: Pattern<'a>> MatchesInternal<'a, P> {

generate_pattern_iterators! {
forward:
/// Return type of `str::matches()`
/// Created with the method `.matches()`.
struct Matches;
reverse:
/// Return type of `str::rmatches()`
/// Created with the method `.rmatches()`.
struct RMatches;
stability:
#[unstable(feature = "core", reason = "type got recently added")]
Expand All @@ -783,7 +783,7 @@ generate_pattern_iterators! {
delegate double ended;
}

/// Return type of `str::lines()`
/// Created with the method `.lines()`.
#[stable(feature = "rust1", since = "1.0.0")]
#[derive(Clone)]
pub struct Lines<'a>(SplitTerminator<'a, char>);
Expand Down Expand Up @@ -811,7 +811,7 @@ impl<'a> DoubleEndedIterator for Lines<'a> {
}
}

/// Return type of `str::lines_any()`
/// Created with the method `.lines_any()`.
#[stable(feature = "rust1", since = "1.0.0")]
#[derive(Clone)]
pub struct LinesAny<'a>(Map<Lines<'a>, LinesAnyMap>);
Expand Down