objc2_foundation/generated/
NSByteCountFormatter.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6
7use crate::*;
8
9/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsbytecountformatterunits?language=objc)
10// NS_OPTIONS
11#[repr(transparent)]
12#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
13pub struct NSByteCountFormatterUnits(pub NSUInteger);
14bitflags::bitflags! {
15    impl NSByteCountFormatterUnits: NSUInteger {
16        #[doc(alias = "NSByteCountFormatterUseDefault")]
17        const UseDefault = 0;
18        #[doc(alias = "NSByteCountFormatterUseBytes")]
19        const UseBytes = 1<<0;
20        #[doc(alias = "NSByteCountFormatterUseKB")]
21        const UseKB = 1<<1;
22        #[doc(alias = "NSByteCountFormatterUseMB")]
23        const UseMB = 1<<2;
24        #[doc(alias = "NSByteCountFormatterUseGB")]
25        const UseGB = 1<<3;
26        #[doc(alias = "NSByteCountFormatterUseTB")]
27        const UseTB = 1<<4;
28        #[doc(alias = "NSByteCountFormatterUsePB")]
29        const UsePB = 1<<5;
30        #[doc(alias = "NSByteCountFormatterUseEB")]
31        const UseEB = 1<<6;
32        #[doc(alias = "NSByteCountFormatterUseZB")]
33        const UseZB = 1<<7;
34        #[doc(alias = "NSByteCountFormatterUseYBOrHigher")]
35        const UseYBOrHigher = 0x0FF<<8;
36        #[doc(alias = "NSByteCountFormatterUseAll")]
37        const UseAll = 0x0FFFF;
38    }
39}
40
41unsafe impl Encode for NSByteCountFormatterUnits {
42    const ENCODING: Encoding = NSUInteger::ENCODING;
43}
44
45unsafe impl RefEncode for NSByteCountFormatterUnits {
46    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
47}
48
49/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsbytecountformattercountstyle?language=objc)
50// NS_ENUM
51#[repr(transparent)]
52#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
53pub struct NSByteCountFormatterCountStyle(pub NSInteger);
54impl NSByteCountFormatterCountStyle {
55    #[doc(alias = "NSByteCountFormatterCountStyleFile")]
56    pub const File: Self = Self(0);
57    #[doc(alias = "NSByteCountFormatterCountStyleMemory")]
58    pub const Memory: Self = Self(1);
59    #[doc(alias = "NSByteCountFormatterCountStyleDecimal")]
60    pub const Decimal: Self = Self(2);
61    #[doc(alias = "NSByteCountFormatterCountStyleBinary")]
62    pub const Binary: Self = Self(3);
63}
64
65unsafe impl Encode for NSByteCountFormatterCountStyle {
66    const ENCODING: Encoding = NSInteger::ENCODING;
67}
68
69unsafe impl RefEncode for NSByteCountFormatterCountStyle {
70    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
71}
72
73extern_class!(
74    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsbytecountformatter?language=objc)
75    #[unsafe(super(NSFormatter, NSObject))]
76    #[derive(Debug, PartialEq, Eq, Hash)]
77    #[cfg(feature = "NSFormatter")]
78    pub struct NSByteCountFormatter;
79);
80
81#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
82extern_conformance!(
83    unsafe impl NSCoding for NSByteCountFormatter {}
84);
85
86#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
87extern_conformance!(
88    unsafe impl NSCopying for NSByteCountFormatter {}
89);
90
91#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
92unsafe impl CopyingHelper for NSByteCountFormatter {
93    type Result = Self;
94}
95
96#[cfg(feature = "NSFormatter")]
97extern_conformance!(
98    unsafe impl NSObjectProtocol for NSByteCountFormatter {}
99);
100
101#[cfg(feature = "NSFormatter")]
102impl NSByteCountFormatter {
103    extern_methods!(
104        #[cfg(feature = "NSString")]
105        #[unsafe(method(stringFromByteCount:countStyle:))]
106        #[unsafe(method_family = none)]
107        pub fn stringFromByteCount_countStyle(
108            byte_count: c_longlong,
109            count_style: NSByteCountFormatterCountStyle,
110        ) -> Retained<NSString>;
111
112        #[cfg(feature = "NSString")]
113        #[unsafe(method(stringFromByteCount:))]
114        #[unsafe(method_family = none)]
115        pub fn stringFromByteCount(&self, byte_count: c_longlong) -> Retained<NSString>;
116
117        #[cfg(all(feature = "NSMeasurement", feature = "NSString", feature = "NSUnit"))]
118        #[unsafe(method(stringFromMeasurement:countStyle:))]
119        #[unsafe(method_family = none)]
120        pub fn stringFromMeasurement_countStyle(
121            measurement: &NSMeasurement<NSUnitInformationStorage>,
122            count_style: NSByteCountFormatterCountStyle,
123        ) -> Retained<NSString>;
124
125        #[cfg(all(feature = "NSMeasurement", feature = "NSString", feature = "NSUnit"))]
126        #[unsafe(method(stringFromMeasurement:))]
127        #[unsafe(method_family = none)]
128        pub fn stringFromMeasurement(
129            &self,
130            measurement: &NSMeasurement<NSUnitInformationStorage>,
131        ) -> Retained<NSString>;
132
133        #[cfg(feature = "NSString")]
134        /// # Safety
135        ///
136        /// `obj` should be of the correct type.
137        #[unsafe(method(stringForObjectValue:))]
138        #[unsafe(method_family = none)]
139        pub unsafe fn stringForObjectValue(
140            &self,
141            obj: Option<&AnyObject>,
142        ) -> Option<Retained<NSString>>;
143
144        #[unsafe(method(allowedUnits))]
145        #[unsafe(method_family = none)]
146        pub fn allowedUnits(&self) -> NSByteCountFormatterUnits;
147
148        /// Setter for [`allowedUnits`][Self::allowedUnits].
149        #[unsafe(method(setAllowedUnits:))]
150        #[unsafe(method_family = none)]
151        pub fn setAllowedUnits(&self, allowed_units: NSByteCountFormatterUnits);
152
153        #[unsafe(method(countStyle))]
154        #[unsafe(method_family = none)]
155        pub fn countStyle(&self) -> NSByteCountFormatterCountStyle;
156
157        /// Setter for [`countStyle`][Self::countStyle].
158        #[unsafe(method(setCountStyle:))]
159        #[unsafe(method_family = none)]
160        pub fn setCountStyle(&self, count_style: NSByteCountFormatterCountStyle);
161
162        #[unsafe(method(allowsNonnumericFormatting))]
163        #[unsafe(method_family = none)]
164        pub fn allowsNonnumericFormatting(&self) -> bool;
165
166        /// Setter for [`allowsNonnumericFormatting`][Self::allowsNonnumericFormatting].
167        #[unsafe(method(setAllowsNonnumericFormatting:))]
168        #[unsafe(method_family = none)]
169        pub fn setAllowsNonnumericFormatting(&self, allows_nonnumeric_formatting: bool);
170
171        #[unsafe(method(includesUnit))]
172        #[unsafe(method_family = none)]
173        pub fn includesUnit(&self) -> bool;
174
175        /// Setter for [`includesUnit`][Self::includesUnit].
176        #[unsafe(method(setIncludesUnit:))]
177        #[unsafe(method_family = none)]
178        pub fn setIncludesUnit(&self, includes_unit: bool);
179
180        #[unsafe(method(includesCount))]
181        #[unsafe(method_family = none)]
182        pub fn includesCount(&self) -> bool;
183
184        /// Setter for [`includesCount`][Self::includesCount].
185        #[unsafe(method(setIncludesCount:))]
186        #[unsafe(method_family = none)]
187        pub fn setIncludesCount(&self, includes_count: bool);
188
189        #[unsafe(method(includesActualByteCount))]
190        #[unsafe(method_family = none)]
191        pub fn includesActualByteCount(&self) -> bool;
192
193        /// Setter for [`includesActualByteCount`][Self::includesActualByteCount].
194        #[unsafe(method(setIncludesActualByteCount:))]
195        #[unsafe(method_family = none)]
196        pub fn setIncludesActualByteCount(&self, includes_actual_byte_count: bool);
197
198        #[unsafe(method(isAdaptive))]
199        #[unsafe(method_family = none)]
200        pub fn isAdaptive(&self) -> bool;
201
202        /// Setter for [`isAdaptive`][Self::isAdaptive].
203        #[unsafe(method(setAdaptive:))]
204        #[unsafe(method_family = none)]
205        pub fn setAdaptive(&self, adaptive: bool);
206
207        #[unsafe(method(zeroPadsFractionDigits))]
208        #[unsafe(method_family = none)]
209        pub fn zeroPadsFractionDigits(&self) -> bool;
210
211        /// Setter for [`zeroPadsFractionDigits`][Self::zeroPadsFractionDigits].
212        #[unsafe(method(setZeroPadsFractionDigits:))]
213        #[unsafe(method_family = none)]
214        pub fn setZeroPadsFractionDigits(&self, zero_pads_fraction_digits: bool);
215
216        #[unsafe(method(formattingContext))]
217        #[unsafe(method_family = none)]
218        pub fn formattingContext(&self) -> NSFormattingContext;
219
220        /// Setter for [`formattingContext`][Self::formattingContext].
221        #[unsafe(method(setFormattingContext:))]
222        #[unsafe(method_family = none)]
223        pub fn setFormattingContext(&self, formatting_context: NSFormattingContext);
224    );
225}
226
227/// Methods declared on superclass `NSObject`.
228#[cfg(feature = "NSFormatter")]
229impl NSByteCountFormatter {
230    extern_methods!(
231        #[unsafe(method(init))]
232        #[unsafe(method_family = init)]
233        pub fn init(this: Allocated<Self>) -> Retained<Self>;
234
235        #[unsafe(method(new))]
236        #[unsafe(method_family = new)]
237        pub fn new() -> Retained<Self>;
238    );
239}
240
241#[cfg(feature = "NSFormatter")]
242impl DefaultRetained for NSByteCountFormatter {
243    #[inline]
244    fn default_retained() -> Retained<Self> {
245        Self::new()
246    }
247}
objc2_foundation/generated/NSByteCountFormatter.rs

objc2_foundation/generated/
NSByteCountFormatter.rs
