pub struct PyNameBuilder { /* private fields */ }Expand description
Builder for DER-encoded X.509 Name SEQUENCE structures.
Constructs a Name by accumulating RelativeDistinguishedName (RDN)
entries, each containing one AttributeTypeAndValue (ATV) with a
UTF8String value. Call :meth:build at the end to obtain the complete
DER bytes.
The output is a complete DER Name TLV suitable for use with
:class:CertificateBuilder and :class:CsrBuilder methods
issuer_name, subject_name.
Each setter method returns the same NameBuilder object, so calls
can be chained with .:
import synta
# CN only
name_der = synta.NameBuilder().common_name("My Root CA").build()
# Full distinguished name
name_der = (
synta.NameBuilder()
.country("US")
.organization("Example Corp")
.organizational_unit("Engineering")
.common_name("example.com")
.build()
)
# Use with CertificateBuilder:
cert = (
synta.CertificateBuilder()
.issuer_name(
synta.NameBuilder().common_name("Test CA").build()
)
.subject_name(
synta.NameBuilder().common_name("Test Leaf").build()
)
...
)Trait Implementations§
impl DerefToPyAny for PyNameBuilder
impl ExtractPyClassWithClone for PyNameBuilder
Source§impl<'py> IntoPyObject<'py> for PyNameBuilder
impl<'py> IntoPyObject<'py> for PyNameBuilder
Source§type Target = PyNameBuilder
type Target = PyNameBuilder
The Python output type
Source§type Output = Bound<'py, <PyNameBuilder as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyNameBuilder as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for PyNameBuilder
impl PyClass for PyNameBuilder
Source§impl PyClassImpl for PyNameBuilder
impl PyClassImpl for PyNameBuilder
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// Builder for DER-encoded X.509 ``Name`` SEQUENCE structures.
///
/// Constructs a ``Name`` by accumulating ``RelativeDistinguishedName`` (RDN)
/// entries, each containing one ``AttributeTypeAndValue`` (ATV) with a
/// ``UTF8String`` value. Call :meth:`build` at the end to obtain the complete
/// DER bytes.
///
/// The output is a complete DER ``Name`` TLV suitable for use with
/// :class:`CertificateBuilder` and :class:`CsrBuilder` methods
/// ``issuer_name``, ``subject_name``.
///
/// Each setter method returns the **same** ``NameBuilder`` object, so calls
/// can be chained with ``.``:
///
/// ```python,ignore
/// import synta
///
/// # CN only
/// name_der = synta.NameBuilder().common_name("My Root CA").build()
///
/// # Full distinguished name
/// name_der = (
/// synta.NameBuilder()
/// .country("US")
/// .organization("Example Corp")
/// .organizational_unit("Engineering")
/// .common_name("example.com")
/// .build()
/// )
///
/// # Use with CertificateBuilder:
/// cert = (
/// synta.CertificateBuilder()
/// .issuer_name(
/// synta.NameBuilder().common_name("Test CA").build()
/// )
/// .subject_name(
/// synta.NameBuilder().common_name("Test Leaf").build()
/// )
/// ...
/// )
/// ```
const RAW_DOC: &'static CStr = /// Builder for DER-encoded X.509 ``Name`` SEQUENCE structures. /// /// Constructs a ``Name`` by accumulating ``RelativeDistinguishedName`` (RDN) /// entries, each containing one ``AttributeTypeAndValue`` (ATV) with a /// ``UTF8String`` value. Call :meth:`build` at the end to obtain the complete /// DER bytes. /// /// The output is a complete DER ``Name`` TLV suitable for use with /// :class:`CertificateBuilder` and :class:`CsrBuilder` methods /// ``issuer_name``, ``subject_name``. /// /// Each setter method returns the **same** ``NameBuilder`` object, so calls /// can be chained with ``.``: /// /// ```python,ignore /// import synta /// /// # CN only /// name_der = synta.NameBuilder().common_name("My Root CA").build() /// /// # Full distinguished name /// name_der = ( /// synta.NameBuilder() /// .country("US") /// .organization("Example Corp") /// .organizational_unit("Engineering") /// .common_name("example.com") /// .build() /// ) /// /// # Use with CertificateBuilder: /// cert = ( /// synta.CertificateBuilder() /// .issuer_name( /// synta.NameBuilder().common_name("Test CA").build() /// ) /// .subject_name( /// synta.NameBuilder().common_name("Test Leaf").build() /// ) /// ... /// ) /// ```
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<PyNameBuilder>
type ThreadChecker = SendablePyClass<PyNameBuilder>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
The closest native ancestor. This is
PyAny by default, and when you declare
#[pyclass(extends=PyDict)], it’s PyDict.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
fn dict_offset() -> Option<isize>
fn weaklist_offset() -> Option<isize>
Source§impl PyClassNewTextSignature for PyNameBuilder
impl PyClassNewTextSignature for PyNameBuilder
const TEXT_SIGNATURE: &'static str = "()"
Source§impl PyMethods<PyNameBuilder> for PyClassImplCollector<PyNameBuilder>
impl PyMethods<PyNameBuilder> for PyClassImplCollector<PyNameBuilder>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyNameBuilder
impl PyTypeInfo for PyNameBuilder
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
Auto Trait Implementations§
impl Freeze for PyNameBuilder
impl RefUnwindSafe for PyNameBuilder
impl Send for PyNameBuilder
impl Sync for PyNameBuilder
impl Unpin for PyNameBuilder
impl UnsafeUnpin for PyNameBuilder
impl UnwindSafe for PyNameBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0:
Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.