Fix #305 Implement Debug for many types #335

imor · 2017-05-10T12:22:18Z

For most types it was a simple matter of adding #[derive(Debug)] but
ParseOptions needed a manual implementation because the type of
log_syntax_violation is Option<&'a Fn(&'static str)> and Fn doesn't
implement Debug. log_syntax_violation is formatted as Some(Fn(&'static
str)) or None depending upon its value.

This change is

For most types it was a simple matter of adding #[derive(Debug)] but ParseOptions needed a manual implementation because the type of log_syntax_violation is Option<&'a Fn(&'static str)> and Fn doesn't implement Debug. log_syntax_violation is formatter as Some(Fn(&'static str)) or None depending upon its value.

Implemented Debug for EncodingOverride as EncodingRef doesn't implement Debug. Field 'encoding' is formatted as Some(EncodingOverride) or None based on its value.

saghm · 2017-05-11T15:59:45Z

Review status: 0 of 6 files reviewed at latest revision, 1 unresolved discussion.

src/encoding.rs, line 98 at r1 (raw file):

        write!(f, "EncodingOverride {{ encoding: ")?;
        match self.encoding {
            Some(_) => write!(f, "Some(EncodingOverride) }}"),

Could this instead call name on the wrapped encoding ref? I think it might be useful to be able to see the the type of the encoding if it's present.

Comments from Reviewable

saghm · 2017-05-11T16:03:55Z

Reviewed 6 of 6 files at r1.
Review status: all files reviewed at latest revision, 1 unresolved discussion.

Comments from Reviewable

turnage · 2017-05-11T17:29:39Z

src/lib.rs

@@ -213,6 +213,16 @@ impl<'a> ParseOptions<'a> {
    }
 }

+impl<'a> Debug for ParseOptions<'a> {


The body of this function can just be

(self.base_url, self.encoding_override).fmt(f)

Edit: I've never done a github review before so if this comment blocks or something feel free to close it with a garbage comment.

What about the log_syntax_violation field? Shouldn't it be included? And as it includes a Fn in the type, how is it usually formatted?

turnage · 2017-05-11T17:30:16Z

src/encoding.rs

@@ -89,9 +90,19 @@ impl EncodingOverride {
    }
 }

+#[cfg(feature = "query_encoding")]
+impl Debug for EncodingOverride {


You can just derive Debug on the structs compiled for each feature.

Can't derive Debug in this case because encoding field has type Option<EncodingRef> and EncodingRef trait isn't Debug

turnage · 2017-05-11T17:30:59Z

src/percent_encoding.rs

@@ -77,7 +77,7 @@ macro_rules! define_encode_set {
 }

 /// This encode set is used for the path of cannot-be-a-base URLs.
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, Debug)]
 #[allow(non_camel_case_types)]
 pub struct SIMPLE_ENCODE_SET;


You need to derive Debug in the encoding set macro to get the rest of *_ENCODE_SET types.

Right, will do.

dtolnay · 2017-05-11T23:04:53Z

The write! approach isn't a great way to do Debug implementations because it doesn't respect the various flags on the Formatter.

use std::fmt::{self, Debug};

struct Good { imor: i32 }
impl Debug for Good {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.debug_struct("Good")
            .field("imor", &self.imor)
            .finish()
    }
}

struct Bad { imor: i32 }
impl Debug for Bad {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        write!(formatter, "Bad {{ imor: {:?} }}", self.imor)
    }
}

fn main() {
    let good = Good { imor: 0 };
    let bad = Bad { imor: 0 };
    println!("default: {:?}", good);
    println!("indented: {:#?}", good);
    println!();
    println!("default: {:?}", bad);
    println!("indented: {:#?}", bad);
}

default: Good { imor: 0 }
indented: Good {
    imor: 0
}

default: Bad { imor: 0 }
indented: Bad { imor: 0 }

Is there a way to do these only using derive(Debug) and debug_struct?

imor · 2017-05-12T12:24:19Z

Review status: 5 of 6 files reviewed at latest revision, 4 unresolved discussions.

src/encoding.rs, line 98 at r1 (raw file):

Previously, saghm (Saghm Rossi) wrote…

Could this instead call name on the wrapped encoding ref? I think it might be useful to be able to see the the type of the encoding if it's present.

Done.

Comments from Reviewable

SimonSapin · 2017-06-13T15:11:39Z

Thanks!

@bors-servo r+

bors-servo · 2017-06-13T15:13:55Z

📌 Commit 81fdb30 has been approved by SimonSapin

bors-servo · 2017-06-13T15:14:04Z

⌛ Testing commit 81fdb30 with merge 4083375...

Fix #305 Implement Debug for many types For most types it was a simple matter of adding #[derive(Debug)] but ParseOptions needed a manual implementation because the type of log_syntax_violation is Option<&'a Fn(&'static str)> and Fn doesn't implement Debug. log_syntax_violation is formatted as Some(Fn(&'static str)) or None depending upon its value.  --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/rust-url/335)

bors-servo · 2017-06-13T15:17:13Z

☀️ Test successful - status-travis
Approved by: SimonSapin
Pushing 4083375 to master...

imor added 4 commits May 10, 2017 17:40

Fix failing build on travis-ci

94af92f

Implemented Debug for EncodingOverride as EncodingRef doesn't implement Debug. Field 'encoding' is formatted as Some(EncodingOverride) or None based on its value.

Add missing 'use' declarations

0ae3540

Remove unused import

01e70b9

turnage suggested changes May 11, 2017

View reviewed changes

Add encoding name in Debug impl for readability

2f0f2f6

Add missing Debug impl for *_ENCODE_SET in define_encode_set macro

81fdb30

bors-servo merged commit 81fdb30 into servo:master Jun 13, 2017

This was referenced Jun 13, 2017

Documentation and examples enhancements of percent encoding #355

Closed

Added RESERVED_ENCODE_SET & STRICT_ENCODE_SET & more detailed docs. #358

Closed

Add support for Serde 1.0 #327

Closed

move percent_encoding to its own crate #347

Closed

imor deleted the impl-debug branch June 22, 2017 08:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #305 Implement Debug for many types #335

Fix #305 Implement Debug for many types #335

imor commented May 10, 2017 •

edited by larsbergstrom

Loading

saghm commented May 11, 2017

saghm commented May 11, 2017

turnage May 11, 2017 •

edited

Loading

imor May 12, 2017 •

edited

Loading

turnage May 11, 2017

imor May 12, 2017 •

edited

Loading

turnage May 11, 2017

imor May 12, 2017

imor May 12, 2017

dtolnay commented May 11, 2017

imor commented May 12, 2017

SimonSapin commented Jun 13, 2017 •

edited

Loading

bors-servo commented Jun 13, 2017

bors-servo commented Jun 13, 2017

bors-servo commented Jun 13, 2017

Fix #305 Implement Debug for many types #335

Fix #305 Implement Debug for many types #335

Conversation

imor commented May 10, 2017 • edited by larsbergstrom Loading

saghm commented May 11, 2017

saghm commented May 11, 2017

turnage May 11, 2017 • edited Loading

Choose a reason for hiding this comment

imor May 12, 2017 • edited Loading

Choose a reason for hiding this comment

turnage May 11, 2017

Choose a reason for hiding this comment

imor May 12, 2017 • edited Loading

Choose a reason for hiding this comment

turnage May 11, 2017

Choose a reason for hiding this comment

imor May 12, 2017

Choose a reason for hiding this comment

imor May 12, 2017

Choose a reason for hiding this comment

dtolnay commented May 11, 2017

imor commented May 12, 2017

SimonSapin commented Jun 13, 2017 • edited Loading

bors-servo commented Jun 13, 2017

bors-servo commented Jun 13, 2017

bors-servo commented Jun 13, 2017

imor commented May 10, 2017 •

edited by larsbergstrom

Loading

turnage May 11, 2017 •

edited

Loading

imor May 12, 2017 •

edited

Loading

imor May 12, 2017 •

edited

Loading

SimonSapin commented Jun 13, 2017 •

edited

Loading