# fidl::Status

## Summary

### Inheritance

Direct Known Subclasses:[fidl::BaseWireResult\< FidlMethod, std::enable_if_t\< FidlMethod::kHasServerToClient \&\&!FidlMethod::kHasServerToClientBody, void \> \>](https://fuchsia.dev/reference/cpp/class/fidl/base-wire-result-fidl-method-std/enable-if-t-fidl-method/k-901108d0a90ec156f93d8d9ff30d99d7), [fidl::BaseWireResult\< FidlMethod, std::enable_if_t\< FidlMethod::kHasServerToClient \&\&FidlMethod::kHasServerToClientBody \&\&!MethodHasUnwrapAccessors\< FidlMethod \>(), void \> \>](https://fuchsia.dev/reference/cpp/class/fidl/base-wire-result-fidl-method-std/enable-if-t-fidl-method/k-6c10670c880180ca9fbbe3a1f67e3605), [fidl::BaseWireResult\< FidlMethod, std::enable_if_t\< FidlMethod::kHasServerToClient \&\&MethodHasUnwrapAccessors\< FidlMethod \>(), void \> \>](https://fuchsia.dev/reference/cpp/class/fidl/base-wire-result-fidl-method-std/enable-if-t-fidl-method/k-997dd19d763f97fcec060ba9af4f3ca0), [fidl::IncomingHeaderAndMessage](https://fuchsia.dev/reference/cpp/class/fidl/incoming-header-and-message), [fidl::OneWayStatus](https://fuchsia.dev/reference/cpp/class/fidl/one-way-status), [fidl::OutgoingMessage](https://fuchsia.dev/reference/cpp/class/fidl/outgoing-message), [fidl::UnbindInfo](https://fuchsia.dev/reference/cpp/class/fidl/unbind-info)

| ### Constructors and Destructors ||
|---|---|
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a01b9625b3dfc9e374c50a8bb2b97e170()` ||
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a14d5c5aeb729f31ffa3d93523961e632(const https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status & result)` ||
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a7e49cbcdc7aa3e9e0ffb6ba9a3d9f41d()` ||

| ### Public functions ||
|---|---|
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a13609a8dab40eacb8890c5079675d0eb() const ` | `std::string` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a5ddbd231638275f88e02701fbd2281b6() const ` | `constexpr const https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status &` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a7340f5a1572d71742c8a0925018da8a1() const ` | `constexpr bool` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1acdf1c326ecff16ad36abbbe916ac03b6() const ` | `constexpr bool` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a84b0de658362a60f8babd298d54157eb() const ` | `constexpr bool` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1af9e0a2613d828fee7998a038e806efff() const ` | `const char *` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a07164a644f904caa9fe33306869c841c() const ` | `constexpr bool` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a93252c888a527b37a72b4a90e9014dcc(const https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status & result)=default` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status &` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a69b9f798ba8ff1bb467704c6d87b6db9() const ` | `constexpr::fidl::Reason` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a7794d2f6849b081960ff1f9425ab961f() const ` | `constexpr zx_status_t` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a66d528b6f7e9695d499e1f11eadec016() const ` | `const char *` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a4e21ffb8a5b0b78810fc805885aaebf8() const ` | `constexpr std::optional<::fidl::Reason >` |

| ### Public static functions ||
|---|---|
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a7caafcb5782118dc770ec25214632051(https://fuchsia.dev/reference/cpp/class/fidl/unbind-info#classfidl_1_1_unbind_info cause)` | `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a4ed8374f04ceba4d57f07aaf736e03df(zx_status_t status, const char *error_message)` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a79e0a3ca3b968f7796e6cb7b9ca59f00(zx_status_t status, const char *error_message)` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1adcd8fbed41bf062b2a7b897eedf36b33()` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1ac57ee53a37bcb222c3d423cf55c79af6(zx_status_t status)` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a8274f1b5df09aebf40f2fbd60916685c()` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1ab72d3ed7d856bfdfc55358fe190197f7(zx_status_t status, const char *error_message)` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1ab0b7a760e44db73f93488f5dd7a06a65()` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a1105df7ce61d62a74391b85c3084d52c(zx_status_t status, const char *error_message)` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a78364af00916480c460efa275088e993()` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a545191e84441ec3dceea7f651373982b()` | `constexpr https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status` |

| ### Protected functions ||
|---|---|
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1ace9978425aec254144e276ca3e0e29a6(char *destination, size_t length, bool from_unbind_info) const ` | `size_t` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a25b357f9932659b27a5509f4648cc489(const https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status & other)` | `constexpr void` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1ab5991b20c92a17d3d82dc91f7dfe88d4()` | `constexpr const char **` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1a944d53b352daf7feca658c0715bc04b7() const ` | `const char *` |
| `https://fuchsia.dev/reference/cpp/class/fidl/status#classfidl_1_1_status_1af72071df5e8f68900fed08533212ab2c() const ` | `const char *` |

## Public functions

### FormatDescription

```c++
std::string FormatDescription() const 
```

### Status

```c++
constexpr Status()=default
```

### Status

```c++
constexpr Status(
  const Status & result
)=default
```

### error

```c++
constexpr const Status & error() const 
```

### is_canceled

```c++
constexpr bool is_canceled() const 
```

### is_dispatcher_shutdown

```c++
constexpr bool is_dispatcher_shutdown() const 
```

### is_peer_closed

```c++
constexpr bool is_peer_closed() const 
```

### lossy_description

```c++
const char * lossy_description() const 
```

### ok

```c++
constexpr bool ok() const 
```

### operator=

```c++
constexpr Status & operator=(
  const Status & result
)=default
```

### reason

```c++
constexpr::fidl::Reason reason() const 
```

### status

```c++
constexpr zx_status_t status() const 
```

### status_string

```c++
const char * status_string() const 
```

### underlying_reason

```c++
constexpr std::optional<::fidl::Reason > underlying_reason() const 
```

### \~Status

```c++
 ~Status()=default
```

## Public static functions

### Canceled

```c++
Status Canceled(
  fidl::UnbindInfo cause
)
```

### DecodeError

```c++
constexpr Status DecodeError(
  zx_status_t status,
  const char *error_message
)
```

### EncodeError

```c++
constexpr Status EncodeError(
  zx_status_t status,
  const char *error_message
)
```

### Ok

```c++
constexpr Status Ok()
```

### PeerClosedWhileReading

```c++
constexpr Status PeerClosedWhileReading(
  zx_status_t status
)
```

### PendingTwoWayCallPreventsUnbind

```c++
constexpr Status PendingTwoWayCallPreventsUnbind()
```

### TransportError

```c++
constexpr Status TransportError(
  zx_status_t status,
  const char *error_message
)
```

### Unbound

```c++
constexpr Status Unbound()
```

### UnexpectedMessage

```c++
constexpr Status UnexpectedMessage(
  zx_status_t status,
  const char *error_message
)
```

### UnknownMethod

```c++
constexpr Status UnknownMethod()
```

### UnknownOrdinal

```c++
constexpr Status UnknownOrdinal()
```

## Protected functions

### FormatImpl

```c++
size_t FormatImpl(
  char *destination,
  size_t length,
  bool from_unbind_info
) const 
```

### SetStatus

```c++
constexpr void SetStatus(
  const Status & other
)
```

### error_address

```c++
constexpr const char ** error_address()
```

### reason_description

```c++
const char * reason_description() const 
```

### underlying_reason_description

```c++
const char * underlying_reason_description() const 
```