actix-web/actix-web/src/http/header/etag.rs

use super::{EntityTag, ETAG};

crate::http::header::common_header! {
    /// `ETag` header, defined in
    /// [RFC 7232 §2.3](https://datatracker.ietf.org/doc/html/rfc7232#section-2.3)
    ///
    /// The `ETag` header field in a response provides the current entity-tag
    /// for the selected representation, as determined at the conclusion of
    /// handling the request.  An entity-tag is an opaque validator for
    /// differentiating between multiple representations of the same
    /// resource, regardless of whether those multiple representations are
    /// due to resource state changes over time, content negotiation
    /// resulting in multiple representations being valid at the same time,
    /// or both.  An entity-tag consists of an opaque quoted string, possibly
    /// prefixed by a weakness indicator.
    ///
    /// # ABNF
    /// ```plain
    /// ETag       = entity-tag
    /// ```
    ///
    /// # Example Values
    /// * `"xyzzy"`
    /// * `W/"xyzzy"`
    /// * `""`
    ///
    /// # Examples
    /// ```
    /// use actix_web::HttpResponse;
    /// use actix_web::http::header::{ETag, EntityTag};
    ///
    /// let mut builder = HttpResponse::Ok();
    /// builder.insert_header(
    ///     ETag(EntityTag::new_strong("xyzzy".to_owned()))
    /// );
    /// ```
    ///
    /// ```
    /// use actix_web::HttpResponse;
    /// use actix_web::http::header::{ETag, EntityTag};
    ///
    /// let mut builder = HttpResponse::Ok();
    /// builder.insert_header(
    ///     ETag(EntityTag::new_weak("xyzzy".to_owned()))
    /// );
    /// ```
    (ETag, ETAG) => [EntityTag]

    test_parse_and_format {
        // From the RFC
        crate::http::header::common_header_test!(test1,
            vec![b"\"xyzzy\""],
            Some(ETag(EntityTag::new_strong("xyzzy".to_owned()))));
        crate::http::header::common_header_test!(test2,
            vec![b"W/\"xyzzy\""],
            Some(ETag(EntityTag::new_weak("xyzzy".to_owned()))));
        crate::http::header::common_header_test!(test3,
            vec![b"\"\""],
            Some(ETag(EntityTag::new_strong("".to_owned()))));
        // Own tests
        crate::http::header::common_header_test!(test4,
            vec![b"\"foobar\""],
            Some(ETag(EntityTag::new_strong("foobar".to_owned()))));
        crate::http::header::common_header_test!(test5,
            vec![b"\"\""],
            Some(ETag(EntityTag::new_strong("".to_owned()))));
        crate::http::header::common_header_test!(test6,
            vec![b"W/\"weak-etag\""],
            Some(ETag(EntityTag::new_weak("weak-etag".to_owned()))));
        crate::http::header::common_header_test!(test7,
            vec![b"W/\"\x65\x62\""],
            Some(ETag(EntityTag::new_weak("\u{0065}\u{0062}".to_owned()))));
        crate::http::header::common_header_test!(test8,
            vec![b"W/\"\""],
            Some(ETag(EntityTag::new_weak("".to_owned()))));
        crate::http::header::common_header_test!(test9,
            vec![b"no-dquotes"],
            None::<ETag>);
        crate::http::header::common_header_test!(test10,
            vec![b"w/\"the-first-w-is-case-sensitive\""],
            None::<ETag>);
        crate::http::header::common_header_test!(test11,
            vec![b""],
            None::<ETag>);
        crate::http::header::common_header_test!(test12,
            vec![b"\"unmatched-dquotes1"],
            None::<ETag>);
        crate::http::header::common_header_test!(test13,
            vec![b"unmatched-dquotes2\""],
            None::<ETag>);
        crate::http::header::common_header_test!(test14,
            vec![b"matched-\"dquotes\""],
            None::<ETag>);
        crate::http::header::common_header_test!(test15,
            vec![b"\""],
            None::<ETag>);
    }
}