Expand description
§ptox
The ptox SDK — a language-neutral toolkit for building file-search clients that work across many networks. It has three parts:
- Contracts —
types(FileQuery,FileResult,Address, …), thesearch::SearchProvidertrait, and thefetch::Fetchertrait. - Engines —
search::fanout, thefetch::FetchRegistry, and themergepost-processor. - Tooling — the NDJSON
providerbridge (the conformance suite is the separateptox-conformancecrate).
Providers (network plugins) and clients (frontends) are built on top.
Re-exports§
pub use engine::Engine;pub use engine::SearchReport;pub use engine::SearchStream;pub use merge::merge;pub use merge::result_id;pub use merge::suggest_filename;pub use merge::MergeOptions;pub use merge::MergedResult;pub use merge::ResultRef;pub use config::CommandConfig;pub use config::Config;pub use config::ConfigError;pub use config::FetchConfig;pub use config::ProviderConfig;pub use config::RankingConfig;pub use config::CONFIG_VERSION;pub use provider::*;pub use search::*;pub use types::*;pub use fetch::*;
Modules§
- config
- A canonical, versioned configuration schema for wiring providers and fetchers into a client.
- engine
- The high-level entry point: providers in, ranked results and fetched files out.
- fetch
- The retrieval half of ptox: turn a
crate::types::Addressinto bytes on disk. - merge
- Deduplicate and rank results from many providers into one list.
- provider
- The provider bridge: the NDJSON wire format and
SubprocessProvider, which runs a provider as a child process so it can be written in any language. - search
- The search half of ptox: the
SearchProvidercontract and thefanoutengine that runs providers concurrently and streams attributed results. - types
- The data contracts shared by every ptox component: queries, results, addresses, failures, and the structural validation used across the wire boundary.