Struct Deprecated 

pub struct Deprecated {
    pub sunset: String,
    pub link: Option<String>,
}

Deprecation metadata for an API resource or endpoint.

Carries the Sunset date (RFC 8594) and an optional Link to replacement documentation. Use inject_headers to attach the standard headers to an HTTP response.

Fields

sunset: String

RFC 7231 HTTP-date (or RFC 3339 date) after which the resource is gone.

Example: "2025-12-31" or "Sat, 31 Dec 2025 00:00:00 GMT".

link: Option<String>

URL of the replacement resource or migration guide (rel="successor-version").

Implementations

impl Deprecated

pub fn new(sunset: impl Into<String>) -> Self

Create a new deprecation marker with the given sunset date.

Examples

use api_bones::deprecated::Deprecated;

let d = Deprecated::new("2025-12-31");
assert_eq!(d.sunset, "2025-12-31");
assert!(d.link.is_none());

pub fn with_link(self, link: impl Into<String>) -> Self

Attach a replacement link.

Examples

use api_bones::deprecated::Deprecated;

let d = Deprecated::new("2025-12-31")
    .with_link("https://api.example.com/v2");
assert_eq!(d.link.as_deref(), Some("https://api.example.com/v2"));

pub fn deprecation_header_value(&self) -> &'static str

Build the value for the Deprecation header.

Per RFC 8594 the value is true for a permanently-deprecated resource.

pub fn sunset_header_value(&self) -> &str

Build the value for the Sunset header (the sunset date as-is).

Examples

use api_bones::deprecated::Deprecated;

let d = Deprecated::new("Sat, 31 Dec 2025 00:00:00 GMT");
assert_eq!(d.sunset_header_value(), "Sat, 31 Dec 2025 00:00:00 GMT");

pub fn link_header_value(&self) -> Option<String>

Build the Link header value for the replacement URL if present.

Produces <url>; rel="successor-version" per RFC 8288.

Examples

use api_bones::deprecated::Deprecated;

let d = Deprecated::new("2025-12-31")
    .with_link("https://api.example.com/v2");
assert_eq!(
    d.link_header_value().as_deref(),
    Some("<https://api.example.com/v2>; rel=\"successor-version\"")
);

Trait Implementations

impl Clone for Deprecated

fn clone(&self) -> Deprecated

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Deprecated

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Deprecated

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Deprecated

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Deprecated

fn eq(&self, other: &Deprecated) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Deprecated

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Deprecated

impl StructuralPartialEq for Deprecated