pulp/api/safe__path_8hpp_source.html

#pragma once


#include <pulp/authoring_capsule/limits.hpp>

#include <pulp/authoring_capsule/status.hpp>

#include <pulp/runtime/result.hpp>


#include <string>

#include <string_view>

#include <vector>


namespace pulp::authoring_capsule {


runtime::Result<std::string, CapsuleError>

admit_member_path(std::string_view raw, const CapsuleLimits& limits = kCapsuleLimitsV1);


std::string collision_key(std::string_view normalized_path);


runtime::Result<void, CapsuleError> check_collisions(const std::vector<std::string>& normalized);


}  // namespace pulp::authoring_capsule

pulp::runtime::Result
Result<T, E> — either holds a T or an E, never both.
Definition result.hpp:76

limits.hpp
Archive and path budgets.

pulp::authoring_capsule
Definition archive.hpp:24

pulp::authoring_capsule::admit_member_path
runtime::Result< std::string, CapsuleError > admit_member_path(std::string_view raw, const CapsuleLimits &limits=kCapsuleLimitsV1)
Verify a member path and return it unchanged.

pulp::authoring_capsule::kCapsuleLimitsV1
constexpr CapsuleLimits kCapsuleLimitsV1
The frozen v1 budgets.
Definition limits.hpp:35

pulp::authoring_capsule::check_collisions
runtime::Result< void, CapsuleError > check_collisions(const std::vector< std::string > &normalized)
Detect a collision across a member set. Returns the first offending pair.

pulp::authoring_capsule::collision_key
std::string collision_key(std::string_view normalized_path)
Fold a normalized path to the key used for collision detection: ASCII case-folded,...

result.hpp
Result<T, E> — success / failure union for fallible operations.

status.hpp
Admission failure vocabulary for authoring capsules.

pulp::authoring_capsule::CapsuleLimits
Definition limits.hpp:18