Skip to content
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.

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

Do not use IoRead or IoError in public API #163

Closed
dtolnay opened this issue Apr 28, 2017 · 1 comment
Closed

Do not use IoRead or IoError in public API #163

dtolnay opened this issue Apr 28, 2017 · 1 comment
Milestone

Comments

@dtolnay
Copy link
Collaborator

@dtolnay dtolnay commented Apr 28, 2017

The rustdoc for BincodeRead currently looks like:

pub trait BincodeRead<'storage>: IoRead { }

IoRead is a renamed import that you use internally. Since this is user-facing, it should use the standard names for std types.

@TyOverby TyOverby added this to the 1.0 milestone Apr 28, 2017
@dtolnay
Copy link
Collaborator Author

@dtolnay dtolnay commented Apr 28, 2017

Same thing for IoError.

pub enum ErrorKind {
    IoError(IoError),
    InvalidEncoding {
        desc: &'static str,
        detail: Option<String>,
    },
    SizeLimit,
    SequenceMustHaveLength,
    Custom(String),
}
@dtolnay dtolnay changed the title Do not use IoRead in public API Do not use IoRead or IoError in public API Apr 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.