Module: binary_content

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.views.binary_content_type_enum import BinaryContentTypeEnum


@dataclass(slots=True, kw_only=True)
class BinaryContent:
    """Display the specified embedded binary content."""

    name: str | None = missing()
    """Content name."""

    content: bytes = missing()
    """Embedded binary content to be displayed as the current view."""

    content_type: BinaryContentTypeEnum | None = missing()
    """Embedded binary content type."""

Classes

class BinaryContent (*, name: str | None = None, content: bytes = None, content_type: BinaryContentTypeEnum | None = None)

Display the specified embedded binary content.

Expand source code

@dataclass(slots=True, kw_only=True)
class BinaryContent:
    """Display the specified embedded binary content."""

    name: str | None = missing()
    """Content name."""

    content: bytes = missing()
    """Embedded binary content to be displayed as the current view."""

    content_type: BinaryContentTypeEnum | None = missing()
    """Embedded binary content type."""

Fields

var content -> bytes: Embedded binary content to be displayed as the current view.
var content_type -> BinaryContentTypeEnum | None: Embedded binary content type.
var name -> str | None: Content name.