Verified Commit b43576e0 authored by William Orr's avatar William Orr
Browse files

Port safety documentation from bitflags v1 

`from_bits_unchecked` is lifted directly from bitflags v1 to preserve compat,
however since it's an unsafe function, it needs a safety notice.
parent 069868f4

src/constants/darwin.rs

+22 −0
Original line number Diff line number Diff line
@@ -47,6 +47,17 @@ bitflags! { 
}



impl EventFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_ushort) -> Self {

        Self::from_bits_retain(bits)
@@ -99,6 +110,17 @@ bitflags! { 
}



impl FilterFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_uint) -> Self {

        Self::from_bits_retain(bits)

src/constants/dragonfly.rs

+22 −0
Original line number Diff line number Diff line
@@ -39,6 +39,17 @@ bitflags! { 
}



impl EventFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_ushort) -> Self {

        Self::from_bits_retain(bits)
@@ -78,6 +89,17 @@ bitflags! { 
}



impl FilterFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_uint) -> Self {

        Self::from_bits_retain(bits)

src/constants/freebsd.rs

+22 −0
Original line number Diff line number Diff line
@@ -44,6 +44,17 @@ bitflags! { 
}



impl EventFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_ushort) -> Self {

        Self::from_bits_retain(bits)
@@ -96,6 +107,17 @@ bitflags! { 
}



impl FilterFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_uint) -> Self {

        Self::from_bits_retain(bits)

src/constants/netbsd.rs

+22 −0
Original line number Diff line number Diff line
@@ -35,6 +35,17 @@ bitflags! { 
}



impl EventFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: u32) -> Self {

        Self::from_bits_retain(bits)
@@ -66,6 +77,17 @@ bitflags! { 
}



impl FilterFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: u32) -> Self {

        Self::from_bits_retain(bits)

src/constants/openbsd.rs

+22 −0
Original line number Diff line number Diff line
@@ -33,6 +33,17 @@ bitflags! { 
}



impl EventFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_ushort) -> Self {

        Self::from_bits_retain(bits)
@@ -67,6 +78,17 @@ bitflags! { 
    }

}

impl FilterFlag {

    /// Convert from underlying bit representation, preserving all

    /// bits (even those not corresponding to a defined flag).

    ///

    /// # Safety

    ///

    /// The caller of the `bitflags!` macro can chose to allow or

    /// disallow extra bits for their bitflags type.

    ///

    /// The caller of `from_bits_unchecked()` has to ensure that

    /// all bits correspond to a defined flag or that extra bits

    /// are valid for this bitflags type.

    #[deprecated = "use the safe `from_bits_retain` method instead"]

    pub const unsafe fn from_bits_unchecked(bits: c_uint) -> Self {

        Self::from_bits_retain(bits)