| {{/* |
| // Copyright 2018 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| */}} |
| |
| {{- define "ProtocolDeclaration" -}} |
| {{- $protocol := . }} |
| |
| #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] |
| pub struct {{ $protocol.Name }}Marker; |
| |
| impl fidl::endpoints::ProtocolMarker for {{ $protocol.Name }}Marker { |
| type Proxy = {{ $protocol.Name }}Proxy; |
| type RequestStream = {{ $protocol.Name }}RequestStream; |
| {{- if .ProtocolName }} |
| const DEBUG_NAME: &'static str = "{{ $protocol.ProtocolName }}"; |
| {{- else }} |
| const DEBUG_NAME: &'static str = "(anonymous) {{ $protocol.Name }}"; |
| {{- end }} |
| } |
| |
| {{- if $protocol.ProtocolName }} |
| impl fidl::endpoints::DiscoverableProtocolMarker for {{ $protocol.Name }}Marker {} |
| {{- end }} |
| |
| {{- range $method := $protocol.Methods }} |
| {{- if and $method.HasError (not $method.IsComposed) }} |
| pub type {{ $method.Response.TupleType }} = {{ $method.Response.TupleTypeAliasRhs }}; |
| {{- end }} |
| {{- end }} |
| |
| pub trait {{ $protocol.Name }}ProxyInterface: Send + Sync { |
| {{- range $method := $protocol.Methods }} |
| {{- if and $method.HasRequest $method.HasResponse }} |
| type {{ $method.CamelName }}ResponseFut: std::future::Future<Output = Result<{{ $method.Response.TupleType }}, fidl::Error>> + Send; |
| {{- end }} |
| |
| {{- if $method.HasRequest }} |
| {{- if $method.IsTransitional }} |
| #[allow(unused_variables)] |
| {{- end }} |
| fn r#{{ $method.Name }}(&self, |
| {{- range $method.Request.Parameters }} |
| {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| ) |
| {{- if $method.HasResponse }} |
| -> Self::{{ $method.CamelName }}ResponseFut |
| {{- else }} |
| -> Result<(), fidl::Error> |
| {{- end }} |
| {{- if $method.IsTransitional }} |
| { unimplemented!("transitional method {{ .Name }} is unimplemented"); } |
| {{- else -}} |
| ; {{- /* Semicolon for no default implementation */}} |
| {{- end }} |
| {{- end }} |
| {{- end }} |
| } |
| |
| #[derive(Debug)] |
| #[cfg(target_os = "fuchsia")] |
| pub struct {{ $protocol.Name }}SynchronousProxy { |
| client: fidl::client::sync::Client, |
| } |
| |
| #[cfg(target_os = "fuchsia")] |
| impl {{ $protocol.Name }}SynchronousProxy { |
| pub fn new(channel: fidl::Channel) -> Self { |
| let protocol_name = <{{ $protocol.Name }}Marker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME; |
| Self { client: fidl::client::sync::Client::new(channel, protocol_name) } |
| } |
| |
| pub fn into_channel(self) -> fidl::Channel { |
| self.client.into_channel() |
| } |
| |
| /// Waits until an event arrives and returns it. It is safe for other |
| /// threads to make concurrent requests while waiting for an event. |
| pub fn wait_for_event(&self, deadline: zx::Time) -> Result<{{ $protocol.Name }}Event, fidl::Error> { |
| {{ $protocol.Name }}Event::decode(self.client.wait_for_event(deadline)?) |
| } |
| |
| {{- range $method := $protocol.Methods }} |
| {{- if $method.HasRequest }} |
| {{- range .DocComments }} |
| ///{{ . }} |
| {{- end }} |
| pub fn r#{{ $method.Name }}(&self, |
| {{- range $method.Request.Parameters }} |
| mut {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| {{- if $method.HasResponse }} |
| ___deadline: zx::Time, |
| {{- end }} |
| ) -> Result<{{- or $method.Response.TupleType "()" }}, fidl::Error> { |
| {{- if $method.HasResponse }} |
| let _response = self.client.send_query::< |
| {{ $method.Request.FidlType }}, |
| {{ $method.Response.FidlType }}, |
| {{- $method.Overflowable.OnRequestEncode }}, |
| {{- $method.Overflowable.OnResponseDecode -}} |
| >( |
| {{ $method.Request.EncodeExpr }}, |
| {{ $method.Ordinal | printf "%#x" }}, |
| {{ $method.DynamicFlags }}, |
| ___deadline, |
| )? |
| {{- if $method.IsFlexible }} |
| .into_result::<{{ $protocol.Name }}Marker>("{{ $method.Name }}")? |
| {{- end }} |
| ; |
| Ok({{ call $method.Response.ConvertToTuple "_response" }}) |
| {{- else }} |
| self.client.send::<{{ $method.Request.FidlType }}, {{ $method.Overflowable.OnRequestEncode }}>( |
| {{ $method.Request.EncodeExpr }}, |
| {{ $method.Ordinal | printf "%#x" }}, |
| {{ $method.DynamicFlags }}, |
| ) |
| {{- end }} |
| } |
| {{- end }} |
| {{- end }} |
| } |
| |
| #[derive(Debug, Clone)] |
| pub struct {{ $protocol.Name }}Proxy { |
| client: fidl::client::Client, |
| } |
| |
| impl fidl::endpoints::Proxy for {{ $protocol.Name }}Proxy { |
| type Protocol = {{ $protocol.Name }}Marker; |
| |
| fn from_channel(inner: fidl::AsyncChannel) -> Self { |
| Self::new(inner) |
| } |
| |
| fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> { |
| self.client.into_channel().map_err(|client| Self { client }) |
| } |
| |
| fn as_channel(&self) -> &::fidl::AsyncChannel { |
| self.client.as_channel() |
| } |
| } |
| |
| impl {{ $protocol.Name }}Proxy { |
| /// Create a new Proxy for {{ $protocol.Name }} |
| pub fn new(channel: fidl::AsyncChannel) -> Self { |
| let protocol_name = <{{ $protocol.Name }}Marker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME; |
| Self { client: fidl::client::Client::new(channel, protocol_name) } |
| } |
| |
| /// Get a Stream of events from the remote end of the {{ $protocol.Name }} protocol |
| /// |
| /// # Panics |
| /// |
| /// Panics if the event stream was already taken. |
| pub fn take_event_stream(&self) -> {{ $protocol.Name }}EventStream { |
| {{ $protocol.Name }}EventStream { |
| event_receiver: self.client.take_event_receiver(), |
| } |
| } |
| |
| {{- range $method := $protocol.Methods }} |
| {{- if $method.HasRequest }} |
| {{- range .DocComments }} |
| ///{{ . }} |
| {{- end }} |
| pub fn r#{{ $method.Name }}(&self, |
| {{- range $request := $method.Request.Parameters }} |
| mut {{ $request.Name }}: {{ $request.Type }}, |
| {{- end }} |
| ) |
| {{- if $method.HasResponse }} |
| -> fidl::client::QueryResponseFut<{{ $method.Response.TupleType }}> { |
| {{- else }} |
| -> Result<(), fidl::Error> { |
| {{- end }} |
| {{ $protocol.Name }}ProxyInterface::r#{{ $method.Name }}(self, |
| {{- range $method.Request.Parameters }} |
| {{ .Name }}, |
| {{- end }} |
| ) |
| } |
| {{- end }} |
| {{- end }} |
| } |
| |
| impl {{ $protocol.Name }}ProxyInterface for {{ $protocol.Name }}Proxy { |
| {{- range $method := $protocol.Methods }} |
| {{- if and $method.HasRequest $method.HasResponse }} |
| type {{ $method.CamelName }}ResponseFut = fidl::client::QueryResponseFut<{{ $method.Response.TupleType }}>; |
| {{- end }} |
| |
| {{- if $method.HasRequest }} |
| {{- if $method.HasResponse }} |
| fn r#{{ $method.Name }}(&self, |
| {{- range $method.Request.Parameters }} |
| mut {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| ) -> Self::{{ $method.CamelName }}ResponseFut { |
| fn _decode(mut _buf: Result<fidl::MessageBufEtc, fidl::Error>) -> Result<{{ $method.Response.TupleType }}, fidl::Error> { |
| let _response = fidl::client::decode_transaction_body::< |
| {{ $method.Response.FidlType }}, {{ $method.Overflowable.OnResponseDecode }} |
| >(_buf?)? |
| {{- if $method.IsFlexible }} |
| .into_result::<{{ $protocol.Name }}Marker>("{{ $method.Name }}")? |
| {{- end }} |
| ; |
| Ok({{ call $method.Response.ConvertToTuple "_response" }}) |
| } |
| self.client.send_query_and_decode::< |
| {{ $method.Request.FidlType }}, |
| {{ $method.Response.TupleType }}, |
| {{ $method.Overflowable.OnRequestEncode }}, |
| >( |
| {{ $method.Request.EncodeExpr }}, |
| {{ $method.Ordinal | printf "%#x" }}, |
| {{ $method.DynamicFlags }}, |
| _decode, |
| ) |
| } |
| {{- else }} |
| fn r#{{ $method.Name }}(&self, |
| {{- range $method.Request.Parameters }} |
| mut {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| ) -> Result<(), fidl::Error> { |
| self.client.send::<{{ $method.Request.FidlType }}, {{ $method.Overflowable.OnRequestEncode }}>( |
| {{ $method.Request.EncodeExpr }}, |
| {{ $method.Ordinal | printf "%#x" }}, |
| {{ $method.DynamicFlags }}, |
| ) |
| } |
| {{- end }} |
| {{- end }} |
| {{- end }} |
| } |
| |
| pub struct {{ $protocol.Name }}EventStream { |
| event_receiver: fidl::client::EventReceiver, |
| } |
| |
| impl std::marker::Unpin for {{ $protocol.Name }}EventStream {} |
| |
| impl futures::stream::FusedStream for {{ $protocol.Name }}EventStream { |
| fn is_terminated(&self) -> bool { |
| self.event_receiver.is_terminated() |
| } |
| } |
| |
| impl futures::Stream for {{ $protocol.Name }}EventStream { |
| type Item = Result<{{ $protocol.Name }}Event, fidl::Error>; |
| |
| fn poll_next(mut self: std::pin::Pin<&mut Self>, cx: &mut std::task::Context<'_>) |
| -> std::task::Poll<Option<Self::Item>> |
| { |
| let buf = match futures::ready!( |
| futures::stream::StreamExt::poll_next_unpin(&mut self.event_receiver, cx)? |
| ) { |
| Some(buf) => buf, |
| None => return std::task::Poll::Ready(None), |
| }; |
| |
| std::task::Poll::Ready(Some({{ $protocol.Name }}Event::decode(buf))) |
| } |
| } |
| |
| #[derive(Debug)] |
| pub enum {{ $protocol.Name }}Event { |
| {{- range $method := $protocol.Methods }} |
| {{- if not $method.HasRequest }} |
| {{ $method.CamelName }} { |
| {{- range $method.Response.Parameters }} |
| {{ .Name }}: {{ .OwnedType }}, |
| {{- end }} |
| }, |
| {{- end }} |
| {{- end }} |
| |
| {{- if $protocol.OneWayUnknownInteractions }} |
| #[non_exhaustive] |
| _UnknownEvent { |
| /// Ordinal of the event that was sent. |
| ordinal: u64, |
| }, |
| {{- end }} |
| } |
| |
| impl {{ $protocol.Name }}Event { |
| {{- range $method := $protocol.Methods }} |
| {{- if not $method.HasRequest }} |
| #[allow(irrefutable_let_patterns)] |
| pub fn into_{{ $method.Name }}(self) -> Option<{{ $method.Response.TupleType }}> { |
| if let {{ $protocol.Name }}Event::{{ $method.CamelName }} { |
| {{- range $method.Response.Parameters }} |
| {{ .Name }}, |
| {{- end }} |
| } = self { |
| Some(( |
| {{- range $index, $param := $method.Response.Parameters }} |
| {{- if $index }}, {{ end }}{{ $param.Name }} |
| {{- end -}} |
| )) |
| } else { |
| None |
| } |
| } |
| {{- end }} |
| {{- end }} |
| |
| /// Decodes a message buffer as a [`{{ $protocol.Name }}Event`]. Transaction |
| /// ID in the message must be zero; this method does not check TXID. |
| fn decode(mut buf: fidl::MessageBufEtc) -> Result<{{ $protocol.Name }}Event, fidl::Error> { |
| let (bytes, _handles) = buf.split_mut(); |
| let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?; |
| |
| match tx_header.ordinal() { |
| {{- range $method := $protocol.Methods }} |
| {{- if not $method.HasRequest }} |
| {{ .Ordinal | printf "%#x" }} => { |
| let mut out = fidl::new_empty!({{ $method.Response.FidlType }}); |
| fidl::duration_begin!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Event"); |
| fidl::trace_blob!("fidl:blob", "decode", bytes); |
| {{- if $method.Overflowable.OnResponseDecode }} |
| fidl::encoding::maybe_overflowing_decode |
| {{- else }} |
| if tx_header.dynamic_flags().contains(fidl::encoding::DynamicFlags::BYTE_OVERFLOW) { |
| return Err(fidl::Error::LargeMessageImpossible) |
| } |
| fidl::encoding::Decoder::decode_into |
| {{- end }}::<{{ $method.Response.FidlType }}>(&tx_header, _body_bytes, _handles, &mut out)?; |
| fidl::duration_end!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "size" => bytes.len() as u32, "handle_count" => _handles.len() as u32); |
| Ok(( |
| {{ $protocol.Name }}Event::{{ $method.CamelName }} { |
| {{- call $method.Response.ConvertToFields "out" }} |
| } |
| )) |
| } |
| {{- end }} |
| {{- end }} |
| {{- if $protocol.OneWayUnknownInteractions }} |
| _ if tx_header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => { |
| Ok({{ $protocol.Name }}Event::_UnknownEvent { |
| ordinal: tx_header.ordinal(), |
| }) |
| // MessageBufEtc will close handles on drop, before the |
| // application can handle the _UnknownEvent variant, so this |
| // satisfies the RFC-0138 requirement to close handles first. |
| } |
| {{- end }} |
| _ => Err(fidl::Error::UnknownOrdinal { |
| ordinal: tx_header.ordinal(), |
| protocol_name: <{{ $protocol.Name }}Marker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME, |
| }) |
| } |
| } |
| } |
| |
| /// A Stream of incoming requests for {{ $protocol.Name }} |
| pub struct {{ $protocol.Name }}RequestStream { |
| inner: std::sync::Arc<fidl::ServeInner>, |
| is_terminated: bool, |
| } |
| |
| impl std::marker::Unpin for {{ $protocol.Name }}RequestStream {} |
| |
| impl futures::stream::FusedStream for {{ $protocol.Name }}RequestStream { |
| fn is_terminated(&self) -> bool { |
| self.is_terminated |
| } |
| } |
| |
| impl fidl::endpoints::RequestStream for {{ $protocol.Name }}RequestStream { |
| type Protocol = {{ $protocol.Name }}Marker; |
| type ControlHandle = {{ $protocol.Name }}ControlHandle; |
| |
| fn from_channel(channel: fidl::AsyncChannel) -> Self { |
| Self { |
| inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), |
| is_terminated: false, |
| } |
| } |
| |
| fn control_handle(&self) -> Self::ControlHandle { |
| {{ $protocol.Name }}ControlHandle { inner: self.inner.clone() } |
| } |
| |
| fn into_inner(self) -> (::std::sync::Arc<fidl::ServeInner>, bool) { |
| (self.inner, self.is_terminated) |
| } |
| |
| fn from_inner(inner: std::sync::Arc<fidl::ServeInner>, is_terminated: bool) |
| -> Self |
| { |
| Self { inner, is_terminated } |
| } |
| } |
| |
| impl futures::Stream for {{ $protocol.Name }}RequestStream { |
| type Item = Result<{{ $protocol.Name }}Request, fidl::Error>; |
| |
| fn poll_next(mut self: std::pin::Pin<&mut Self>, cx: &mut std::task::Context<'_>) |
| -> std::task::Poll<Option<Self::Item>> |
| { |
| let this = &mut *self; |
| if this.inner.poll_shutdown(cx) { |
| this.is_terminated = true; |
| return std::task::Poll::Ready(None); |
| } |
| if this.is_terminated { |
| panic!("polled {{ $protocol.Name }}RequestStream after completion"); |
| } |
| fidl::encoding::with_tls_decode_buf(|bytes, handles| { |
| match this.inner.channel().read_etc(cx, bytes, handles) { |
| std::task::Poll::Ready(Ok(())) => {}, |
| std::task::Poll::Pending => return std::task::Poll::Pending, |
| std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => { |
| this.is_terminated = true; |
| return std::task::Poll::Ready(None); |
| } |
| std::task::Poll::Ready(Err(e)) => return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(e)))), |
| } |
| |
| // A message has been received from the channel |
| let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?; |
| if !header.is_compatible() { |
| return std::task::Poll::Ready(Some(Err(fidl::Error::IncompatibleMagicNumber(header.magic_number())))); |
| } |
| |
| std::task::Poll::Ready(Some(match header.ordinal() { |
| {{- range $method := $protocol.Methods }} |
| {{- if $method.HasRequest }} |
| {{ .Ordinal | printf "%#x" }} => { |
| let mut req = fidl::new_empty!({{ $method.Request.FidlType }}); |
| fidl::duration_begin!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Request"); |
| fidl::trace_blob!("fidl:blob", "decode", bytes); |
| {{- if $method.Overflowable.OnRequestDecode }} |
| fidl::encoding::maybe_overflowing_decode |
| {{- else }} |
| if header.dynamic_flags().contains(fidl::encoding::DynamicFlags::BYTE_OVERFLOW) { |
| Err(fidl::Error::LargeMessageImpossible)?; |
| } |
| fidl::encoding::Decoder::decode_into |
| {{- end }}::<{{ $method.Request.FidlType }}>(&header, _body_bytes, handles, &mut req)?; |
| fidl::duration_end!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "size" => bytes.len() as u32, "handle_count" => handles.len() as u32); |
| let control_handle = {{ $protocol.Name }}ControlHandle { |
| inner: this.inner.clone(), |
| }; |
| |
| Ok({{ $protocol.Name }}Request::{{ $method.CamelName }} { |
| {{- call $method.Request.ConvertToFields "req" }} |
| {{- if $method.HasResponse }} |
| responder: {{- $protocol.Name }}{{- $method.CamelName }}Responder { |
| control_handle: std::mem::ManuallyDrop::new(control_handle), |
| tx_id: header.tx_id(), |
| ordinal: header.ordinal(), |
| }, |
| {{- else }} |
| control_handle, |
| {{- end }} |
| }) |
| } |
| {{- end }} |
| {{- end }} |
| {{- if $protocol.OneWayUnknownInteractions }} |
| _ if header.tx_id() == 0 && header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => { |
| let control_handle = {{ $protocol.Name }}ControlHandle { |
| inner: this.inner.clone(), |
| }; |
| Ok({{ $protocol.Name }}Request::_UnknownMethod { |
| ordinal: header.ordinal(), |
| control_handle, |
| {{- if $protocol.TwoWayUnknownInteractions }} |
| unknown_method_type: fidl::endpoints::UnknownMethodType::OneWay, |
| {{- end }} |
| }) |
| // with_tls_decode_buf will clear the handles when we return |
| // before the application can handle the _UnknownMethod, so |
| // we don't need to clear it explicitly to meet the RFC |
| // requirement to close handles before calling an unknown |
| // interaction handler. |
| } |
| {{- if $protocol.TwoWayUnknownInteractions }} |
| _ if header.dynamic_flags().contains(fidl::encoding::DynamicFlags::FLEXIBLE) => { |
| let control_handle = {{ $protocol.Name }}ControlHandle { |
| inner: this.inner.clone(), |
| }; |
| |
| let msg = fidl::encoding::TransactionMessage { |
| header: fidl::encoding::TransactionHeader::new( |
| header.tx_id(), header.ordinal(), header.dynamic_flags(), |
| ), |
| body: fidl::encoding::Flexible::<()>::FrameworkErr( |
| fidl::encoding::FrameworkErr::UnknownMethod |
| ), |
| }; |
| |
| // RFC-0138 requires us to close handles in the incoming |
| // message before replying, so we can't wait for |
| // with_tls_decode_buf to auto-clear handles when we return. |
| handles.clear(); |
| |
| // We are inside of with_tls_decode_buf, so we can't use |
| // with_tls_encode_buf. However, we know that the unknown |
| // interaction reply will not contain any handles, so |
| // creating a new Vec here does not cause an allocation. |
| let mut handles = Vec::new(); |
| fidl::duration_begin!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}_UnknownMethodResponse"); |
| fidl::encoding::Encoder::encode::< |
| fidl::encoding::TransactionMessageType<fidl::encoding::FlexibleType<fidl::encoding::EmptyStruct>> |
| >(bytes, &mut handles, msg)?; |
| fidl::trace_blob!("fidl:blob", "encode", bytes.as_slice()); |
| fidl::duration_end!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "size" => bytes.len() as u32, "handle_count" => handles.len() as u32); |
| |
| control_handle.inner.send_raw_msg(&*bytes, &mut handles)?; |
| |
| Ok({{ $protocol.Name }}Request::_UnknownMethod { |
| ordinal: header.ordinal(), |
| control_handle, |
| unknown_method_type: fidl::endpoints::UnknownMethodType::TwoWay, |
| }) |
| } |
| {{- end }} |
| {{- end }} |
| _ => Err(fidl::Error::UnknownOrdinal { |
| ordinal: header.ordinal(), |
| protocol_name: <{{ $protocol.Name }}Marker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME, |
| }), |
| })) |
| }) |
| } |
| } |
| |
| {{- range .DocComments }} |
| ///{{ . }} |
| {{- end }} |
| #[derive(Debug)] |
| pub enum {{ $protocol.Name }}Request { |
| {{- range $method := $protocol.Methods }} |
| {{- if $method.HasRequest }} |
| {{- range .DocComments }} |
| ///{{ . }} |
| {{- end }} |
| {{ $method.CamelName }} { |
| {{- range $method.Request.Parameters }} |
| {{ .Name }}: {{ .OwnedType }}, |
| {{- end }} |
| {{- if $method.HasResponse }} |
| responder: {{ $protocol.Name }}{{ $method.CamelName }}Responder, |
| {{- else }} |
| control_handle: {{ $protocol.Name }}ControlHandle, |
| {{- end }} |
| }, |
| {{- end }} |
| {{- end }} |
| |
| {{- if $protocol.OneWayUnknownInteractions }} |
| /// An interaction was received which does not match any known method. |
| #[non_exhaustive] |
| _UnknownMethod { |
| /// Ordinal of the method that was called. |
| ordinal: u64, |
| control_handle: {{ $protocol.Name }}ControlHandle, |
| {{- if $protocol.TwoWayUnknownInteractions }} |
| unknown_method_type: fidl::endpoints::UnknownMethodType, |
| {{- end }} |
| }, |
| {{- end }} |
| } |
| |
| impl {{ $protocol.Name }}Request { |
| {{- range $method := $protocol.Methods }} |
| {{- if $method.HasRequest }} |
| #[allow(irrefutable_let_patterns)] |
| pub fn into_{{ $method.Name }}(self) -> Option<( |
| {{- range $method.Request.Parameters }} |
| {{ .OwnedType }}, |
| {{- end }} |
| {{- if $method.HasResponse }} |
| {{ $protocol.Name }}{{ $method.CamelName }}Responder |
| {{- else }} |
| {{ $protocol.Name }}ControlHandle |
| {{- end }} |
| )> { |
| if let {{ $protocol.Name }}Request::{{ $method.CamelName }} { |
| {{- range $method.Request.Parameters }} |
| {{ .Name }}, |
| {{- end }} |
| {{- if $method.HasResponse }} |
| responder, |
| {{- else }} |
| control_handle, |
| {{- end }} |
| } = self { |
| Some(( |
| {{- range $method.Request.Parameters }} |
| {{- .Name }}, |
| {{- end }} |
| {{- if $method.HasResponse }} |
| responder |
| {{- else }} |
| control_handle |
| {{- end -}} |
| )) |
| } else { |
| None |
| } |
| } |
| {{- end }} |
| {{- end }} |
| |
| /// Name of the method defined in FIDL |
| pub fn method_name(&self) -> &'static str { |
| match *self { |
| {{- range $method := $protocol.Methods }} |
| {{- if $method.HasRequest }} |
| {{ $protocol.Name }}Request::{{ $method.CamelName }}{..} => "{{ $method.Name }}", |
| {{- end }} |
| {{- end }} |
| |
| {{- if $protocol.TwoWayUnknownInteractions }} |
| {{ $protocol.Name }}Request::_UnknownMethod { |
| unknown_method_type: fidl::endpoints::UnknownMethodType::OneWay, .. |
| } => "unknown one-way method", |
| {{ $protocol.Name }}Request::_UnknownMethod { |
| unknown_method_type: fidl::endpoints::UnknownMethodType::TwoWay, .. |
| } => "unknown two-way method", |
| {{- else if $protocol.OneWayUnknownInteractions }} |
| {{ $protocol.Name }}Request::_UnknownMethod {..} => "unknown one-way method", |
| {{- end }} |
| } |
| } |
| } |
| |
| #[derive(Debug, Clone)] |
| pub struct {{ $protocol.Name }}ControlHandle { |
| inner: std::sync::Arc<fidl::ServeInner>, |
| } |
| |
| impl fidl::endpoints::ControlHandle for {{ $protocol.Name }}ControlHandle { |
| fn shutdown(&self) { |
| self.inner.shutdown() |
| } |
| |
| fn shutdown_with_epitaph(&self, status: zx_status::Status) { |
| self.inner.shutdown_with_epitaph(status) |
| } |
| |
| fn is_closed(&self) -> bool { |
| self.inner.channel().is_closed() |
| } |
| |
| fn on_closed<'a>(&'a self) -> fidl::OnSignals<'a> { |
| self.inner.channel().on_closed() |
| } |
| } |
| |
| impl {{ $protocol.Name }}ControlHandle { |
| {{- range $method := $protocol.Methods }} |
| {{- if not $method.HasRequest }} |
| pub fn send_{{ $method.Name }}(&self, |
| {{- range $method.Response.Parameters }} |
| mut {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| ) -> Result<(), fidl::Error> { |
| self.inner.send::<{{ $method.Response.FidlType }}, {{ $method.Overflowable.OnResponseEncode }}>( |
| {{ $method.Response.EncodeExpr }}, |
| 0, |
| {{ $method.Ordinal | printf "%#x" }}, |
| {{ $method.DynamicFlags }} |
| ) |
| } |
| {{- end }} |
| {{- end }} |
| |
| } |
| |
| {{- range $method := $protocol.Methods }} |
| {{- if and $method.HasRequest $method.HasResponse }} |
| #[must_use = "FIDL methods require a response to be sent"] |
| #[derive(Debug)] |
| pub struct {{ $protocol.Name }}{{ $method.CamelName }}Responder { |
| control_handle: std::mem::ManuallyDrop<{{ $protocol.Name }}ControlHandle>, |
| tx_id: u32, |
| ordinal: u64, |
| } |
| |
| /// Set the the channel to be shutdown (see [`{{ $protocol.Name }}ControlHandle::shutdown`]) |
| /// if the responder is dropped without sending a response, so that the client |
| /// doesn't hang. To prevent this behavior, call `drop_without_shutdown`. |
| impl std::ops::Drop for {{ $protocol.Name }}{{ $method.CamelName }}Responder { |
| fn drop(&mut self) { |
| self.control_handle.shutdown(); |
| // Safety: drops once, never accessed again |
| unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) }; |
| } |
| } |
| |
| impl fidl::endpoints::Responder for {{ $protocol.Name }}{{ $method.CamelName }}Responder { |
| type ControlHandle = {{ $protocol.Name }}ControlHandle; |
| |
| fn control_handle(&self) -> &{{ $protocol.Name }}ControlHandle { |
| &self.control_handle |
| } |
| |
| fn drop_without_shutdown(mut self) { |
| // Safety: drops once, never accessed again due to mem::forget |
| unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) }; |
| // Prevent Drop from running (which would shut down the channel) |
| std::mem::forget(self); |
| } |
| } |
| |
| impl {{ $protocol.Name }}{{ $method.CamelName }}Responder { |
| /// Sends a response to the FIDL transaction. |
| /// |
| /// Sets the channel to shutdown if an error occurs. |
| pub fn send(self, |
| {{- range $method.Response.Parameters }} |
| mut {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| ) -> Result<(), fidl::Error> { |
| let r = self.send_raw( |
| {{- range $method.Response.Parameters }} |
| {{ .Name }}, |
| {{- end }} |
| ); |
| if r.is_err() { |
| self.control_handle.shutdown(); |
| } |
| self.drop_without_shutdown(); |
| r |
| } |
| |
| /// Similar to "send" but does not shutdown the channel if |
| /// an error occurs. |
| pub fn send_no_shutdown_on_err(self, |
| {{- range $method.Response.Parameters }} |
| mut {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| ) -> Result<(), fidl::Error> { |
| let r = self.send_raw( |
| {{- range $method.Response.Parameters }} |
| {{ .Name }}, |
| {{- end }} |
| ); |
| self.drop_without_shutdown(); |
| r |
| } |
| |
| fn send_raw(&self, |
| {{- range $method.Response.Parameters }} |
| mut {{ .Name }}: {{ .Type }}, |
| {{- end }} |
| ) -> Result<(), fidl::Error> { |
| let msg = fidl::encoding::TransactionMessage { |
| header: fidl::encoding::TransactionHeader::new( |
| self.tx_id, self.ordinal, {{ $method.DynamicFlags }}, |
| ), |
| body: {{ $method.Response.EncodeExpr }}, |
| }; |
| |
| fidl::encoding::with_tls_encode_buf(|bytes, handles| { |
| fidl::duration_begin!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Response"); |
| fidl::encoding::Encoder::encode::< |
| fidl::encoding::TransactionMessageType<{{ $method.Response.FidlType }}> |
| >(bytes, handles, msg)?; |
| {{- if $method.Overflowable.OnResponseEncode }} |
| fidl::encoding::maybe_overflowing_after_encode(bytes, handles)?; |
| {{- end }} |
| fidl::trace_blob!("fidl:blob", "encode", bytes.as_slice()); |
| fidl::duration_end!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "size" => bytes.len() as u32, "handle_count" => handles.len() as u32); |
| |
| self.control_handle.inner.send_raw_msg(&*bytes, &mut *handles) |
| }) |
| } |
| } |
| {{- end }} |
| {{- end }} |
| {{- end }} |
