Struct FilterProxy

pub struct FilterProxy { /* private fields */ }

Implementations

impl FilterProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.net.filter.deprecated/Filter.

pub fn take_event_stream(&self) -> FilterEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn enable_interface( &self, id: u64, ) -> QueryResponseFut<FilterEnableInterfaceResult, DefaultFuchsiaResourceDialect>

Enable the filter on a specific interface.

The filter is disabled by default. If the filter is already enabled, no error is returned.

• request id The id of the network interface.

• error Reports NOT_FOUND if id is not a valid interface.

pub fn disable_interface( &self, id: u64, ) -> QueryResponseFut<FilterDisableInterfaceResult, DefaultFuchsiaResourceDialect>

Disable the filter on a specific interface.

The filter is disabled by default. If the filter is already disabled, no error is returned.

• request id The id of the network interface.

• error Reports NOT_FOUND if id is not a valid interface.

pub fn get_rules( &self, ) -> QueryResponseFut<(Vec<Rule>, u32), DefaultFuchsiaResourceDialect>

GetRules gets the current rules. They do not include NAT or RDR rules. (use GetNatRules or GetRdrRules instead).

• response rules The current filter rules.
• response generation The generation number associated with the current rules.

pub fn update_rules( &self, rules: &[Rule], generation: u32, ) -> QueryResponseFut<FilterUpdateRulesResult, DefaultFuchsiaResourceDialect>

UpdateRules updates the current rules. It does not update NAT or RDR rules (use UpdateNatRules or UpdateRdrRules instead).

UpdateRules takes a generation number that is previously returned from GetRules. The generation number has to be up-to-date, i.e. it has to match with the one associated with the current rules. The service will assign a new generation number to the new rules.

• request rules The new filter rules to install.
• request generation The generation number previously returned from GetRules.

• error Reports GENERATION_MISMATCH if generation is not the generation number for the current rules.
• error Reports BAD_RULE if rules are not valid.

pub fn get_nat_rules( &self, ) -> QueryResponseFut<(Vec<Nat>, u32), DefaultFuchsiaResourceDialect>

GetNatRules gets the current NAT rules.

• response rules The current NAT rules.
• response generation The generation number associated with the current NAT rules.

pub fn update_nat_rules( &self, rules: &[Nat], generation: u32, ) -> QueryResponseFut<FilterUpdateNatRulesResult, DefaultFuchsiaResourceDialect>

UpdateNatRules updates the current NAT rules.

UpdateNatRules takes a generation number that is previously returned from GetRules. The generation number has to be up-to-date, i.e. it has to match with the one associated with the current NAT rules. The service will assign a new generation number to the new NAT rules.

• request rules The new NAT rules to install.
• request generation The generation number previously returned from GetNATRules.

• error Reports GENERATION_MISMATCH if generation is not the generation number for the current rules.
• error Reports BAD_RULE if rules are not valid.

pub fn get_rdr_rules( &self, ) -> QueryResponseFut<(Vec<Rdr>, u32), DefaultFuchsiaResourceDialect>

GetRdrRules gets the current RDR rules.

• response rules The current RDR rules.
• response generation The generation number associated with the current RDR rules.

pub fn update_rdr_rules( &self, rules: &[Rdr], generation: u32, ) -> QueryResponseFut<FilterUpdateRdrRulesResult, DefaultFuchsiaResourceDialect>

UpdateRdrRules updates the previous RDR rules with new rules.

UpdateRdrRules takes a generation number that is previously returned from GetRules. The generation number has to be up-to-date, i.e. it has to match with the one associated with the current RDR rules. The service will assign a new generation number to the new RDR rules.

• request rules The new RDR rules to install.
• request generation The generation number previously returned from GetRDRRules.

• error Reports NOT_SUPPORTED if the operation is not supported.

pub fn check_presence( &self, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

No-op method that allows checking for presence.

It’s not currently possible for a client with an optionally-provided protocol to check whether there’s someone on the other end without making a FIDL call (https://fxbug.dev/296283299). This method provides a workaround by giving a client a two-way method that it can call to check for liveness.

Trait Implementations

impl Clone for FilterProxy

fn clone(&self) -> FilterProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FilterProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FilterProxyInterface for FilterProxy

type EnableInterfaceResponseFut = QueryResponseFut<Result<(), EnableDisableInterfaceError>>

type DisableInterfaceResponseFut = QueryResponseFut<Result<(), EnableDisableInterfaceError>>

type GetRulesResponseFut = QueryResponseFut<(Vec<Rule>, u32)>

type UpdateRulesResponseFut = QueryResponseFut<Result<(), FilterUpdateRulesError>>

type GetNatRulesResponseFut = QueryResponseFut<(Vec<Nat>, u32)>

type UpdateNatRulesResponseFut = QueryResponseFut<Result<(), FilterUpdateNatRulesError>>

type GetRdrRulesResponseFut = QueryResponseFut<(Vec<Rdr>, u32)>

type UpdateRdrRulesResponseFut = QueryResponseFut<Result<(), FilterUpdateRdrRulesError>>

type CheckPresenceResponseFut = QueryResponseFut<()>

fn enable_interface(&self, id: u64) -> Self::EnableInterfaceResponseFut

fn disable_interface(&self, id: u64) -> Self::DisableInterfaceResponseFut

fn get_rules(&self) -> Self::GetRulesResponseFut

fn update_rules( &self, rules: &[Rule], generation: u32, ) -> Self::UpdateRulesResponseFut

fn get_nat_rules(&self) -> Self::GetNatRulesResponseFut

fn update_nat_rules( &self, rules: &[Nat], generation: u32, ) -> Self::UpdateNatRulesResponseFut

fn get_rdr_rules(&self) -> Self::GetRdrRulesResponseFut

fn update_rdr_rules( &self, rules: &[Rdr], generation: u32, ) -> Self::UpdateRdrRulesResponseFut

fn check_presence(&self) -> Self::CheckPresenceResponseFut

impl Proxy for FilterProxy

type Protocol = FilterMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.