Skip to main content

CodexEndpoint

Struct CodexEndpoint 

Source
pub struct CodexEndpoint { /* private fields */ }
Expand description

Local endpoint configuration around one canonical coordinated runtime.

Implementations§

Source§

impl CodexEndpoint

Source

pub fn new( runtime: Arc<dyn SdkRuntime>, runtime_id: impl Into<String>, cwd: impl Into<PathBuf>, ) -> Result<(Arc<Self>, CodexBootstrapCredential), CredentialError>

Source

pub fn with_mode( runtime: Arc<dyn SdkRuntime>, runtime_id: impl Into<String>, cwd: impl Into<PathBuf>, mode: CodexCompatibilityMode, ) -> Result<(Arc<Self>, CodexBootstrapCredential), CredentialError>

Source

pub fn with_forwarded_ports( self: Arc<Self>, ports: impl IntoIterator<Item = u16>, ) -> Result<Arc<Self>, CredentialError>

Declare operator-created SSH forward ports without opening or managing a tunnel. The listener remains numeric IPv4 loopback.

Source

pub fn with_client_home( self: Arc<Self>, path: impl Into<PathBuf>, ) -> Result<Arc<Self>, CredentialError>

Declare the isolated Codex preference home returned by initialize. The directory remains owned by the launcher, not by canonical state.

Source

pub fn issue_interactive( self: &Arc<Self>, bootstrap: &CodexBootstrapCredential, client_id: impl Into<String>, ) -> Result<CodexClientCredential, CredentialError>

Source

pub fn issue_observer( self: &Arc<Self>, bootstrap: &CodexBootstrapCredential, client_id: impl Into<String>, ) -> Result<CodexClientCredential, CredentialError>

Source

pub async fn rotate_interactive( self: &Arc<Self>, bootstrap: &CodexBootstrapCredential, credential: &mut CodexClientCredential, client_id: impl Into<String>, ) -> Result<CodexClientCredential, CredentialError>

Source

pub fn rotate_bootstrap( &self, bootstrap: &mut CodexBootstrapCredential, ) -> Result<CodexBootstrapCredential, CredentialError>

Replace the operator bootstrap capability for this runtime generation. The old value is invalidated and zeroized before the replacement is returned to the caller.

Source

pub fn rotate_bootstrap_file( &self, bootstrap: &mut CodexBootstrapCredential, bootstrap_file: &mut CodexBootstrapFile, runtime_dir: impl Into<PathBuf>, ) -> Result<(CodexBootstrapCredential, CodexBootstrapFile), CredentialError>

Rotate both the in-memory bootstrap and its private Unix file. The new destination is created first; the authenticated server map is then switched and the old file/value are removed before acknowledgement.

Source

pub async fn revoke_frontend( &self, bootstrap: &CodexBootstrapCredential, credential: &mut CodexClientCredential, ) -> Result<(), CredentialError>

Revoke a frontend credential and wait until its active channel and lease have been released before acknowledging.

Source

pub fn write_bootstrap_file( &self, bootstrap: &CodexBootstrapCredential, runtime_dir: impl Into<PathBuf>, ) -> Result<CodexBootstrapFile, CredentialError>

Persist the bootstrap capability through the single private writer. This is the launcher path; frontend credentials never use this file.

Source

pub fn issue_interactive_from_file( self: &Arc<Self>, bootstrap_file: &CodexBootstrapFile, client_id: impl Into<String>, ) -> Result<CodexClientCredential, CredentialError>

Mint the stock TUI credential after authenticating the private bootstrap file. The returned frontend grant still excludes terminate.

Source

pub async fn revoke_frontend_from_file( &self, bootstrap_file: &CodexBootstrapFile, credential: &mut CodexClientCredential, ) -> Result<(), CredentialError>

Source

pub async fn terminate( self: &Arc<Self>, bootstrap: &CodexBootstrapCredential, ) -> Result<(), CredentialError>

Close the canonical runtime through the operator-only bootstrap path.

Source

pub async fn bind_websocket( self: &Arc<Self>, port: u16, ) -> Result<CodexServerHandle>

Bind only numeric IPv4 loopback. There is no arbitrary-address API.

Source

pub async fn bind_unix( self: &Arc<Self>, socket_path: impl Into<PathBuf>, ) -> Result<CodexServerHandle>

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
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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