blob: 993b285dda8317051d9619db892f9470db3f24e5 [file] [log] [blame]
// 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.
package codegen
const protocolTmpl = `
{{- define "ResponseType" -}}
{{ if .Result }}
{{ .Result.Name }}HandleWrapper
{{- else -}}{{/* if not .Result */}}
{{- range $index, $response := .Response -}}
{{- if .HasHandleMetadata -}}
{{ .HandleWrapperName }}<{{- $response.Type -}}>,
{{- else -}}
{{- $response.Type -}},
{{- end -}}
{{- end -}}{{/* end range */}}
{{- end -}}
{{- end -}}{{/* ResponseType */}}
{{- define "RemoveHandleWrappers" -}}
{{- if (eq (len .) 1) -}}
{{- if (index . 0).HasHandleMetadata -}}
_value.0.into_inner()
{{- else -}}
_value.0
{{- end -}}
{{- else -}}{{/* if (ne (len .) 1) */}}
(
{{- range $index, $response := . -}}
{{ if .HasHandleMetadata }}
_value.{{ $index }}.into_inner(),
{{ else }}
_value.{{ $index }},
{{- end -}}
{{- end -}}{{/* end range */}}
)
{{ end }}
{{ end }}{{/* RemoveHandleWrappers */}}
{{- define "ResponseValue" -}}
{{ if .Result }}
_value.map(|_value| {{ template "RemoveHandleWrappers" .Result.Ok }})
{{ else }}
{{ template "RemoveHandleWrappers" .Response }}
{{ end }}
{{ end }}{{/* ResponseValue */}}
{{- define "ProtocolDeclaration" -}}
{{- $protocol := . }}
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct {{ $protocol.Name }}Marker;
impl fidl::endpoints::ServiceMarker for {{ $protocol.Name }}Marker {
type Proxy = {{ $protocol.Name }}Proxy;
type RequestStream = {{ $protocol.Name }}RequestStream;
{{- if .ServiceName }}
const DEBUG_NAME: &'static str = "{{ $protocol.ServiceName }}";
{{- else }}
const DEBUG_NAME: &'static str = "(anonymous) {{ $protocol.Name }}";
{{- end }}
}
{{- if $protocol.ServiceName }}
impl fidl::endpoints::DiscoverableService for {{ $protocol.Name }}Marker {}
{{- end }}
pub trait {{ $protocol.Name }}ProxyInterface: Send + Sync {
{{- range $method := $protocol.Methods }}
{{- if $method.HasResponse }}
type {{ $method.CamelName }}ResponseFut: std::future::Future<Output = Result<(
{{- range $index, $response := $method.Response -}}
{{- if (eq $index 0) -}} {{ $response.Type }}
{{- else -}}, {{ $response.Type }} {{- end -}}
{{- end -}}
), fidl::Error>> + Send;
{{- end -}}
{{- if $method.HasRequest }}
{{- if $method.IsTransitional -}}
#[allow(unused_variables)]
{{- end }}
fn r#{{ $method.Name }}(&self,
{{- range $request := $method.Request }}
{{ $request.Name }}: {{ $request.BorrowedType }},
{{- 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 service_name = <{{ $protocol.Name }}Marker as fidl::endpoints::ServiceMarker>::DEBUG_NAME;
Self { client: fidl::client::sync::Client::new(channel, service_name) }
}
pub fn into_channel(self) -> fidl::Channel {
self.client.into_channel()
}
{{- range $method := $protocol.Methods }}
{{- if $method.HasRequest }}
{{- range .DocComments}}
///{{ . }}
{{- end}}
pub fn r#{{ $method.Name }}(&mut self,
{{- range $request := $method.Request }}
mut {{ $request.Name }}: {{ $request.BorrowedType }},
{{- end }}
{{- if $method.HasResponse -}}
___deadline: zx::Time,
{{- end -}}
) -> Result<(
{{- range $index, $response := $method.Response -}}
{{- if (eq $index 0) -}} {{ $response.Type }}
{{- else -}}, {{ $response.Type }} {{- end -}}
{{- end -}}
), fidl::Error> {
{{- if $method.HasResponse -}}
let _value: (
{{ template "ResponseType" $method }}
) = self.client.send_query(&mut (
{{- range $index, $request := $method.Request -}}
{{- if (eq $index 0) -}} {{ $request.Name }}
{{- else -}}, {{ $request.Name }} {{- end -}}
{{- end -}}
),
{{ $method.Ordinal | printf "%#x" }},
___deadline,
)?;
Ok({{ template "ResponseValue" $method }})
{{- else -}}
self.client.send(&mut (
{{- range $index, $request := $method.Request -}}
{{- if (eq $index 0) -}} {{ $request.Name }}
{{- else -}}, {{ $request.Name }} {{- end -}}
{{- end -}}
),
{{ $method.Ordinal | printf "%#x" }},
)
{{- end -}}
}
{{- end -}}
{{- end }}
}
#[derive(Debug, Clone)]
pub struct {{ $protocol.Name }}Proxy {
client: fidl::client::Client,
}
impl fidl::endpoints::Proxy for {{ $protocol.Name }}Proxy {
type Service = {{ $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 service_name = <{{ $protocol.Name }}Marker as fidl::endpoints::ServiceMarker>::DEBUG_NAME;
Self { client: fidl::client::Client::new(channel, service_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 }}
mut {{ $request.Name }}: {{ $request.BorrowedType }},
{{- end }}
)
{{- if $method.HasResponse -}}
-> fidl::client::QueryResponseFut<(
{{- range $index, $response := $method.Response -}}
{{- if (eq $index 0) -}} {{ $response.Type }}
{{- else -}}, {{ $response.Type }} {{- end -}}
{{- end -}}
)> {
{{- else -}}
-> Result<(), fidl::Error> {
{{- end }}
{{ $protocol.Name }}ProxyInterface::r#{{ $method.Name }}(self,
{{- range $request := $method.Request }}
{{ $request.Name }},
{{- end }}
)
}
{{- end -}}
{{- end }}
}
impl {{ $protocol.Name}}ProxyInterface for {{ $protocol.Name}}Proxy {
{{- range $method := $protocol.Methods }}
{{- if $method.HasResponse }}
type {{ $method.CamelName }}ResponseFut = fidl::client::QueryResponseFut<(
{{- range $index, $response := $method.Response -}}
{{- if (eq $index 0) -}} {{ $response.Type }}
{{- else -}}, {{ $response.Type }} {{- end -}}
{{- end -}}
)>;
{{- end -}}
{{- if $method.HasRequest }}
{{- if $method.HasResponse -}}
fn r#{{ $method.Name }}(&self,
{{- range $request := $method.Request }}
mut {{ $request.Name }}: {{ $request.BorrowedType }},
{{- end }}
) -> Self::{{ $method.CamelName}}ResponseFut {
fn transform(result: Result<(
{{ template "ResponseType" $method }}
), fidl::Error>) -> Result<(
{{- range $index, $response := $method.Response -}}
{{- if (eq $index 0) -}} {{- $response.Type -}}
{{- else -}}, {{- $response.Type -}} {{- end -}}
{{- end -}}
), fidl::Error> {
result.map(|_value| {{ template "ResponseValue" $method }})
}
let send_result = self.client.call_send_raw_query(&mut (
{{- range $index, $request := $method.Request -}}
{{- if (eq $index 0) -}} {{ $request.Name }}
{{- else -}}, {{ $request.Name }} {{- end -}}
{{- end -}}
), {{ $method.Ordinal | printf "%#x" }});
QueryResponseFut(match send_result {
Ok(res_fut) => {
future::maybe_done(res_fut.and_then(|buf| decode_transaction_body_fut(buf, transform)))
}
Err(e) => MaybeDone::Done(Err(e)),
})
}
{{- else -}}
fn r#{{ $method.Name }}(&self,
{{- range $request := $method.Request }}
mut {{ $request.Name }}: {{ $request.BorrowedType }},
{{- end }}
) -> Result<(), fidl::Error> {
self.client.send(&mut (
{{- range $index, $request := $method.Request -}}
{{- if (eq $index 0) -}} {{ $request.Name }}
{{- else -}}, {{ $request.Name }} {{- end -}}
{{- end -}}
), {{ $method.Ordinal | printf "%#x" }})
}
{{- 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 mut 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),
};
let (bytes, _handles) = buf.split_mut();
let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
std::task::Poll::Ready(Some(match tx_header.ordinal() {
{{- range $method := $protocol.Methods }}
{{- if not $method.HasRequest }}
{{ .Ordinal | printf "%#x" }} => {
let mut out_tuple: (
{{- range $index, $param := $method.Response -}}
{{- if .HasHandleMetadata -}}
{{ .HandleWrapperName }}<{{- $param.Type -}}>,
{{- else -}}
{{- $param.Type -}},
{{- end -}}
{{- end -}}
) = fidl::encoding::Decodable::new_empty();
fidl::duration_begin!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Event");
fidl::trace_blob!("fidl:blob", "decode", bytes);
fidl::encoding::Decoder::decode_into(&tx_header, _body_bytes, _handles, &mut out_tuple)?;
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 }} {
{{- range $index, $param := $method.Response -}}
{{ if $param.HasHandleMetadata }}
{{- $param.Name -}}: out_tuple.{{- $index -}}.into_inner(),
{{- else -}}
{{- $param.Name -}}: out_tuple.{{- $index -}},
{{- end -}}
{{- end -}}
}
))
}
{{- end -}}
{{- end }}
_ => Err(fidl::Error::UnknownOrdinal {
ordinal: tx_header.ordinal(),
service_name: <{{ $protocol.Name }}Marker as fidl::endpoints::ServiceMarker>::DEBUG_NAME,
})
}))
}
}
#[derive(Debug)]
pub enum {{ $protocol.Name }}Event {
{{ range $method := $protocol.Methods }}
{{ if not $method.HasRequest }}
{{ $method.CamelName }} {
{{ range $param := $method.Response }}
{{ $param.Name }}: {{ $param.Type }},
{{ end }}
},
{{- end -}}
{{- end -}}
}
impl {{ $protocol.Name }}Event {
{{- range $method := $protocol.Methods }}
{{- if not $method.HasRequest }}
#[allow(irrefutable_let_patterns)]
pub fn into_{{ $method.Name }}(self) -> Option<(
{{- range $index, $param := $method.Response }}
{{- if (eq $index 0) -}} {{ $param.Type }}
{{- else -}}, {{ $param.Type }} {{- end -}}
{{ end }}
)> {
if let {{ $protocol.Name }}Event::{{ $method.CamelName }} {
{{- range $param := $method.Response }}
{{ $param.Name }},
{{ end }}
} = self {
Some((
{{- range $index, $param := $method.Response -}}
{{- if (eq $index 0) -}} {{ $param.Name -}}
{{- else -}}, {{ $param.Name }} {{- end -}}
{{- end -}}
))
} else {
None
}
}
{{ end }}
{{- end }}
}
/// A type which can be used to send responses and events into a borrowed channel.
///
/// Note: this should only be used when the channel must be temporarily
/// borrowed. For a typical sending of events, use the send_ methods
/// on the ControlHandle types, which can be acquired through a
/// RequestStream or Responder type.
#[deprecated(note = "Use {{ $protocol.Name }}RequestStream / Responder instead")]
pub struct {{ $protocol.Name }}ServerSender<'a> {
// Some protocols don't define events which would render this channel unused.
#[allow(dead_code)]
channel: &'a fidl::Channel,
}
#[allow(deprecated)]
impl <'a> {{ $protocol.Name }}ServerSender<'a> {
pub fn new(channel: &'a fidl::Channel) -> Self {
Self { channel }
}
{{- range $method := $protocol.Methods }}
{{- if not $method.HasRequest }}
pub fn send_{{ $method.Name }}(&self
{{- range $param := $method.Response -}},
mut {{ $param.Name -}}: {{ $param.BorrowedType -}}
{{- end -}}
) -> Result<(), fidl::Error> {
fidl::encoding::with_tls_encode_buf(|bytes_, handles_| {
{{ $protocol.Name }}Encoder::encode_{{ $method.Name }}_response(
bytes_, handles_,
{{- range $index, $param := $method.Response -}}
{{ $param.Name -}},
{{- end -}}
)?;
self.channel.write_etc(&*bytes_, &mut *handles_).map_err(fidl::Error::ServerResponseWrite)?;
Ok(())
})
}
{{- end -}}
{{- if and $method.HasRequest $method.HasResponse }}
pub fn send_{{ $method.Name }}_response(&self,
txid: fidl::client::Txid
{{- range $param := $method.Response -}},
mut {{ $param.Name -}}: {{ $param.BorrowedType -}}
{{- end -}}
) -> Result<(), fidl::Error> {
fidl::encoding::with_tls_encode_buf(|bytes_, handles_| {
{{ $protocol.Name }}Encoder::encode_{{ $method.Name }}_response(
bytes_, handles_,
txid.as_raw_id(),
{{- range $index, $param := $method.Response -}}
{{ $param.Name -}},
{{- end -}}
)?;
self.channel.write_etc(&*bytes_, &mut *handles_).map_err(fidl::Error::ServerResponseWrite)?;
Ok(())
})
}
{{- end -}}
{{- end }}
}
/// 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 Service = {{ $protocol.Name }}Marker;
/// Consume a channel to make a {{ $protocol.Name }}RequestStream
fn from_channel(channel: fidl::AsyncChannel) -> Self {
Self {
inner: std::sync::Arc::new(fidl::ServeInner::new(channel)),
is_terminated: false,
}
}
/// ControlHandle for the remote connection
type ControlHandle = {{ $protocol.Name }}ControlHandle;
/// ControlHandle for the remote connection
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: (
{{- range $index, $param := $method.Request -}}
{{- if .HasHandleMetadata -}}
{{ .HandleWrapperName }}<{{- $param.Type -}}>,
{{- else -}}
{{- $param.Type -}},
{{- end -}}
{{- end -}}
) = fidl::encoding::Decodable::new_empty();
fidl::duration_begin!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Request");
fidl::trace_blob!("fidl:blob", "decode", bytes);
fidl::encoding::Decoder::decode_into(&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 }} {
{{- range $index, $param := $method.Request -}}
{{- if .HasHandleMetadata -}}
{{ $param.Name }}: req.{{ $index }}.into_inner(),
{{- else -}}
{{ $param.Name }}: req.{{ $index }},
{{- end -}}
{{- end -}}
{{- 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 }}
_ => Err(fidl::Error::UnknownOrdinal {
ordinal: header.ordinal(),
service_name: <{{ $protocol.Name }}Marker as fidl::endpoints::ServiceMarker>::DEBUG_NAME,
}),
}))
})
}
}
/// Represents a single request.
/// RequestMessages should only be used for manual deserialization when higher level
/// structs such as RequestStream cannot be used. One usually would only encounter
/// such scenarios when working with legacy FIDL code (prior to FIDL generated client/server bindings).
#[derive(Debug)]
#[deprecated(note = "Use {{ $protocol.Name }}Request instead")]
pub enum {{ $protocol.Name }}RequestMessage {
{{- range $method := $protocol.Methods }}
{{- if $method.HasRequest }}
{{- range .DocComments}}
///{{ . }}
{{- end}}
{{ $method.CamelName }} {
{{ range $index, $param := $method.Request }}
{{ $param.Name }}: {{ $param.Type }},
{{ end -}}
{{- if $method.HasResponse -}}
tx_id: fidl::client::Txid,
{{- end -}}
},
{{- end }}
{{- end }}
}
#[allow(deprecated)]
impl {{ $protocol.Name }}RequestMessage {
pub fn decode(bytes: &[u8], _handles: &mut [fidl::HandleInfo]) -> Result<{{ $protocol.Name }}RequestMessage, fidl::Error> {
let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
match header.ordinal() {
{{- range $method := $protocol.Methods }}
{{- if $method.HasRequest }}
{{ .Ordinal | printf "%#x" }} => {
let mut out_tuple: (
{{- range $index, $param := $method.Request -}}
{{- if .HasHandleMetadata -}}
{{ .HandleWrapperName }}<{{- $param.Type -}}>,
{{- else -}}
{{- $param.Type -}},
{{- end -}}
{{- end -}}
) = fidl::encoding::Decodable::new_empty();
fidl::duration_begin!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Request");
fidl::trace_blob!("fidl:blob", "decode", bytes);
fidl::encoding::Decoder::decode_into(&header, _body_bytes, _handles, &mut out_tuple)?;
fidl::duration_end!("fidl", "decode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "size" => bytes.len() as u32, "handle_count" => _handles.len() as u32);
Ok({{ $protocol.Name }}RequestMessage::{{ $method.CamelName }} {
{{- range $index, $param := $method.Request -}}
{{- if .HasHandleMetadata -}}
{{ $param.Name }}: out_tuple.{{ $index }}.into_inner(),
{{- else -}}
{{ $param.Name }}: out_tuple.{{ $index }},
{{- end -}}
{{- end -}}
{{- if $method.HasResponse -}}
tx_id: header.tx_id().into(),
{{- end -}}
})
}
{{- end }}
{{- end }}
_ => Err(fidl::Error::UnknownOrdinal {
ordinal: header.ordinal(),
service_name: <{{ $protocol.Name }}Marker as fidl::endpoints::ServiceMarker>::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 $index, $param := $method.Request }}
{{ $param.Name }}: {{ $param.Type }},
{{ end -}}
{{- if $method.HasResponse -}}
responder: {{ $protocol.Name }}{{ $method.CamelName }}Responder,
{{- else -}}
control_handle: {{ $protocol.Name }}ControlHandle,
{{- end -}}
},
{{- 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 $param := $method.Request }}
{{ $param.Type }},
{{ end }}
{{- if $method.HasResponse -}}
{{ $protocol.Name }}{{ $method.CamelName }}Responder
{{- else -}}
{{ $protocol.Name }}ControlHandle
{{- end }}
)> {
if let {{ $protocol.Name }}Request::{{ $method.CamelName }} {
{{- range $param := $method.Request }}
{{ $param.Name }},
{{ end }}
{{- if $method.HasResponse -}}
responder,
{{- else -}}
control_handle,
{{- end }}
} = self {
Some((
{{- range $param := $method.Request -}}
{{- $param.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 }}
}
}
}
pub struct {{ $protocol.Name }}Encoder;
impl {{ $protocol.Name }}Encoder {
{{- range $method := $protocol.Methods }}
{{- if $method.HasRequest }}
pub fn encode_{{ $method.Name }}_request<'a>(
out_bytes: &'a mut Vec<u8>,
out_handles: &'a mut Vec<fidl::HandleDisposition<'static>>,
{{- if $method.HasResponse }}
tx_id: u32,
{{- end -}}
{{- range $index, $param := $method.Request -}}
mut in_{{ $param.Name -}}: {{ $param.BorrowedType -}},
{{- end -}}
) -> Result<(), fidl::Error> {
let header = fidl::encoding::TransactionHeader::new(
{{- if $method.HasResponse }}
tx_id,
{{- else -}}
0,
{{- end -}}
{{ $method.Ordinal | printf "%#x" }});
let mut body = (
{{- range $index, $param := $method.Request -}}
in_{{ $param.Name -}},
{{- end -}}
);
let mut msg = fidl::encoding::TransactionMessage { header, body: &mut body };
fidl::duration_begin!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Request");
fidl::encoding::Encoder::encode(out_bytes, out_handles, &mut msg)?;
fidl::trace_blob!("fidl:blob", "encode", out_bytes.as_slice());
fidl::duration_end!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "size" => out_bytes.len() as u32, "handle_count" => out_handles.len() as u32);
Ok(())
}
{{- end }}
{{- if $method.HasResponse }}
pub fn encode_{{ $method.Name }}_response<'a>(
out_bytes: &'a mut Vec<u8>,
out_handles: &'a mut Vec<fidl::HandleDisposition<'static>>,
{{- if $method.HasRequest }}
tx_id: u32,
{{- end -}}
{{- range $param := $method.Response -}}
mut in_{{ $param.Name -}}: {{ $param.BorrowedType -}},
{{- end -}}
) -> Result<(), fidl::Error> {
let header = fidl::encoding::TransactionHeader::new(
{{- if $method.HasRequest }}
tx_id,
{{- else -}}
0,
{{- end -}}
{{ $method.Ordinal | printf "%#x" }});
let mut body = (
{{- range $index, $param := $method.Response -}}
in_{{ $param.Name -}},
{{- end -}}
);
let mut msg = fidl::encoding::TransactionMessage { header, body: &mut body };
fidl::duration_begin!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "name" => "{{ $protocol.ECI }}{{ $method.CamelName }}Response");
fidl::encoding::Encoder::encode(out_bytes, out_handles, &mut msg)?;
fidl::trace_blob!("fidl:blob", "encode", out_bytes.as_slice());
fidl::duration_end!("fidl", "encode", "bindings" => _FIDL_TRACE_BINDINGS_RUST, "size" => out_bytes.len() as u32, "handle_count" => out_handles.len() as u32);
Ok(())
}
{{- end }}
{{- end -}}
}
#[derive(Debug, Clone)]
pub struct {{ $protocol.Name }}ControlHandle {
inner: std::sync::Arc<fidl::ServeInner>,
}
impl {{ $protocol.Name }}ControlHandle {
/// Set the server to shutdown. The underlying channel is only closed the
/// next time the stream is polled.
pub fn shutdown(&self) {
self.inner.shutdown()
}
pub fn shutdown_with_epitaph(&self, status: zx_status::Status) {
self.inner.shutdown_with_epitaph(status)
}
{{- range $method := $protocol.Methods }}
{{- if not $method.HasRequest }}
pub fn send_{{ $method.Name }}(&self
{{- range $param := $method.Response -}},
mut {{ $param.Name -}}: {{ $param.BorrowedType -}}
{{- end -}}
) -> Result<(), fidl::Error> {
let mut response = (
{{- range $index, $param := $method.Response -}}
{{- if ne 0 $index -}}, {{ $param.Name -}}
{{- else -}} {{ $param.Name -}}
{{- end -}}
{{- end -}}
);
let mut msg = fidl::encoding::TransactionMessage {
header: fidl::encoding::TransactionHeader::new(0, {{ $method.Ordinal | printf "%#x" }}),
body: &mut response,
};
fidl::encoding::with_tls_encoded(&mut msg, |bytes, handles| {
self.inner.channel().write_etc(&*bytes, &mut *handles).map_err(fidl::Error::ServerResponseWrite)
})?;
Ok(())
}
{{ 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 {{ $protocol.Name }}{{ $method.CamelName }}Responder {
pub fn control_handle(&self) -> &{{ $protocol.Name }}ControlHandle {
&self.control_handle
}
/// Drop the Responder without setting the channel to shutdown.
///
/// This method shouldn't normally be used-- instead, send a response
/// to prevent the channel from shutting down.
pub 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);
}
/// Sends a response to the FIDL transaction.
///
/// Sets the channel to shutdown if an error occurs.
pub fn send(self,
{{- range $param := $method.Response -}}
mut {{ $param.Name -}}: {{ $param.BorrowedType -}},
{{- end -}}
) -> Result<(), fidl::Error> {
let r = self.send_raw(
{{- range $index, $param := $method.Response -}}
{{ $param.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 $param := $method.Response -}}
mut {{ $param.Name -}}: {{ $param.BorrowedType -}},
{{- end -}}
) -> Result<(), fidl::Error> {
let r = self.send_raw(
{{- range $index, $param := $method.Response -}}
{{ $param.Name -}},
{{- end -}}
);
self.drop_without_shutdown();
r
}
fn send_raw(&self,
{{- range $param := $method.Response -}}
mut {{ $param.Name -}}: {{ $param.BorrowedType -}},
{{- end -}}
) -> Result<(), fidl::Error> {
let mut response = (
{{- range $index, $param := $method.Response -}}
{{- if ne 0 $index -}}, {{ $param.Name -}}
{{- else -}} {{ $param.Name -}}
{{- end -}}
{{- end -}}
);
let mut msg = fidl::encoding::TransactionMessage {
header: fidl::encoding::TransactionHeader::new(self.tx_id, self.ordinal),
body: &mut response,
};
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(bytes, handles, &mut 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);
self.control_handle.inner.channel().write_etc(&*bytes, &mut *handles)
.map_err(fidl::Error::ServerResponseWrite)?;
Ok(())
})
}
}
{{- end -}}
{{- end -}}
{{- end -}}
`