manga

Documentation

Index

• type Chapter
  • func (chapter *Chapter) SetConverted()
• type Page
• type PageContainer
  • func NewContainer(Page *Page, img image.Image, format string, isToBeConverted bool) *PageContainer

Types

type Chapter

type Chapter struct {
	// FilePath is the path to the chapter's directory.
	FilePath string
	// Pages is a slice of pointers to Page objects.
	Pages []*Page
	// ComicInfo is a string containing information about the chapter.
	ComicInfoXml string
	// IsConverted is a boolean that indicates whether the chapter has been converted.
	IsConverted bool
	// ConvertedTime is a pointer to a time.Time object that indicates when the chapter was converted. Nil mean not converted.
	ConvertedTime time.Time
}

func (*Chapter) SetConverted

func (chapter *Chapter) SetConverted()

SetConverted sets the IsConverted field to true and sets the ConvertedTime field to the current time.

type Page

type Page struct {
	// Index of the page in the chapter.
	Index uint16 `json:"index" jsonschema:"description=Index of the page in the chapter."`
	// Extension of the page image.
	Extension string `json:"extension" jsonschema:"description=Extension of the page image."`
	// Size of the page in bytes
	Size uint64 `json:"-"`
	// Contents of the page
	Contents *bytes.Buffer `json:"-"`
	// IsSplitted tell us if the page was cropped to multiple pieces
	IsSplitted bool `json:"is_cropped" jsonschema:"description=Was this page cropped."`
	// SplitPartIndex represent the index of the crop if the page was cropped
	SplitPartIndex uint16 `json:"crop_part_index" jsonschema:"description=Index of the crop if the image was cropped."`
}

type PageContainer

type PageContainer struct {
	// Page is a pointer to a manga page object.
	Page *Page
	// Image is the decoded image of the manga page.
	Image image.Image
	// Format is a string representing the format of the image (e.g., "png", "jpeg", "webp").
	Format string
	// IsToBeConverted is a boolean flag indicating whether the image needs to be converted to another format.
	IsToBeConverted bool
}

PageContainer is a struct that holds a manga page, its image, and the image format.

func NewContainer

func NewContainer(Page *Page, img image.Image, format string, isToBeConverted bool) *PageContainer