pub enum EngineRequest {
    StartEditTransaction {
        transaction: ServerEnd<EditTransactionMarker>,
        control_handle: EngineControlHandle,
    },
    List {
        iterator: ServerEnd<RuleIteratorMarker>,
        control_handle: EngineControlHandle,
    },
    ListStatic {
        iterator: ServerEnd<RuleIteratorMarker>,
        control_handle: EngineControlHandle,
    },
    TestApply {
        url: String,
        responder: EngineTestApplyResponder,
    },
}
Expand description

This manages fuchsia-pkg:// rewrite rules.

When a package resolver is asked to resolve a fuchsia-pkg URL, it must first iterate through its sequence of rewrite rules (given by [List]). The rewrite engine will rewrite the given URL with the first rule that:

  • matches the given URL
  • produces a valid URL when applied to the given URL

If no rules match, the URL is resolved as-is.

This is intended to be implemented by package resolver components, and used by repository administration tools.

Variants§

§

StartEditTransaction

Fields

§transaction: ServerEnd<EditTransactionMarker>
§control_handle: EngineControlHandle

Begins a rule edit transaction.

  • request transaction a request for an [EditTransaction].
§

List

Fields

§iterator: ServerEnd<RuleIteratorMarker>
§control_handle: EngineControlHandle

Returns an iterator over all rewrite rules.

  • request iterator a request for an iterator.
§

ListStatic

Fields

§iterator: ServerEnd<RuleIteratorMarker>
§control_handle: EngineControlHandle

Returns an iterator over all static (immutable) rewrite rules. These rules are handled as lower priority than dynamic rules and cannot be modified (although they can be overridden) by [EditTransaction]s.

  • request iterator a request for an iterator.
§

TestApply

Rewrites the given url with the current rewrite rule set, returning the rewritten url. If no rules match or a rule matches but performs an identity transformation, this API returns url unchanged.

This API is intended only for reflecting on rule side effects. Using this API to pre-apply the rules, then passing the result to [fuchsia.pkg/PackageResolver.Resolve] would apply the rules twice.

  • request url the url to rewrite.
  • response rewritten the rewritten url.
  • error a zx_status value indicating failure. One of the following:
    • ZX_ERR_INVALID_ARGS if url is not a valid fuchsia-pkg:// URL. See fuchsia-pkg URL.

Implementations§

Trait Implementations§

source§

impl Debug for EngineRequest

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more