-
Notifications
You must be signed in to change notification settings - Fork 13.1k
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
Add lossless debug implementation for unix OsStrs #46798
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT | ||
// file at the top-level directory of this distribution and at | ||
// http://rust-lang.org/COPYRIGHT. | ||
// | ||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or | ||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license | ||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your | ||
// option. This file may not be copied, modified, or distributed | ||
// except according to those terms. | ||
|
||
#![allow(dead_code)] | ||
|
||
use fmt::{Formatter, Result, Write}; | ||
use std_unicode::lossy::{Utf8Lossy, Utf8LossyChunk}; | ||
|
||
pub fn debug_fmt_bytestring(slice: &[u8], f: &mut Formatter) -> Result { | ||
// Writes out a valid unicode string with the correct escape sequences | ||
fn write_str_escaped(f: &mut Formatter, s: &str) -> Result { | ||
for c in s.chars().flat_map(|c| c.escape_debug()) { | ||
f.write_char(c)? | ||
} | ||
Ok(()) | ||
} | ||
|
||
f.write_str("\"")?; | ||
for Utf8LossyChunk { valid, broken } in Utf8Lossy::from_bytes(slice).chunks() { | ||
write_str_escaped(f, valid)?; | ||
for b in broken { | ||
write!(f, "\\x{:02X}", b)?; | ||
} | ||
} | ||
f.write_str("\"") | ||
} | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
use super::*; | ||
use fmt::{Formatter, Result, Debug}; | ||
|
||
#[test] | ||
fn smoke() { | ||
struct Helper<'a>(&'a [u8]); | ||
|
||
impl<'a> Debug for Helper<'a> { | ||
fn fmt(&self, f: &mut Formatter) -> Result { | ||
debug_fmt_bytestring(self.0, f) | ||
} | ||
} | ||
|
||
let input = b"\xF0hello,\tworld"; | ||
let expected = r#""\xF0hello,\tworld""#; | ||
let output = format!("{:?}", Helper(input)); | ||
|
||
assert!(output == expected); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this still required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, on windows builds the function is never called.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it work if we do
#[cfg(any(unix, target_os = "redox", target_arch = "wasm32"))] pub mod bytestring
instead? I already see some of that forpub mod gnu
andpub mod net
. That way we continue to catch accidental dead code in this file.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so - see
src\tools\tidy\src\pal.rs
It looks like the goal is to avoid having platform specific code in
sys_common
andnet
is a temporary exception. The closest existing file to this iswtf8
, which also uses#[allow(dead_code)]
.