.\" zip_source.mdoc -- description of zip data source
.\" Copyright (C) 2014-2021 Dieter Baron and Thomas Klausner
.\"
.\" This file is part of libzip, a library to manipulate ZIP archives.
.\" The authors can be contacted at <info@libzip.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\" 3. The names of the authors may not be used to endorse or promote
.\"    products derived from this software without specific prior
.\"    written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd May 5, 2025
.Dt ZIP_SOURCE 5
.Os
.SH "نام (NAME)"
zip_source \- ساختار منبع داده zip در libzip
.Sh "کتابخانه (LIBRARY)"
libzip (-lzip)
.Sh "خلاصه دستور (SYNOPSIS)"
.In zip.h
.Vt zip_source_t *source ;
.Sh "توضیحات (DESCRIPTION)"
یک
.Vt zip_source_t
نمایانگر یک منبع داده است (یا مقصد هنگام استفاده برای نوشتن).
.Xr libzip 3
از آن برای افزودن یا جایگزینی محتویات پرونده برای یک پرونده در یک آرشیو zip استفاده می‌کند.
اگر منبع از پیمایش (seeking) پشتیبانی کند، می‌تواند برای باز کردن آرشیوهای zip از آن نیز استفاده شود.
.Pp
داده‌ها می‌توانند از یک پرونده روی دیسک
.Xr ( zip_source_file 3 ،
.Xr zip_source_file_create 3 ،
.Xr zip_source_filep 3
یا
.Xr zip_source_filep_create 3 ) ،
حافظه
.Xr ( zip_source_buffer 3 ،
.Xr zip_source_buffer_create 3 ،
.Xr zip_source_buffer_fragment 3
یا
.Xr zip_source_buffer_fragment_create 3 ) ،
یک پرونده درون یک آرشیو
.Xr ( zip_source_zip 3 ) ،
یا ارائه‌شده از طریق یک تابع بازخوانی (callback function)
.Xr ( zip_source_function 3
یا
.Xr zip_source_function_create 3 )
فراهم شوند.
.Xr zip_source_window 3
یا
.Xr zip_source_window_create 3
می‌تواند برای محدود کردن دسترسی به بخشی از داده‌های موجود استفاده شود.
.Pp
همچنین می‌تواند به عنوان یک فیلتر برای پردازش داده‌های ارائه‌شده توسط یک
.Vt zip_source_t
زیرین استفاده شود (به عنوان مثال، برای فشرده‌سازی آن یا محاسبه checksum)، که با
.Xr zip_source_layered 3
یا
.Xr zip_source_layered_create 3
ایجاد می‌شود.
.Pp
منابع با
.Xr zip_source_free 3
آزاد می‌شوند.
.Pp
منابع باید از خواندن پشتیبانی کنند، و می‌توانند به صورت اختیاری از پیمایش (seeking) و نوشتن نیز پشتیبانی کنند.
.Pp
.Vt zip_source_t
دارای شمارش ارجاع (reference counted) است و با مقدار شمارش ارجاع ۱ ایجاد می‌شود.
.Xr zip_open_from_source 3 ،
.Xr zip_file_add 3
و
.Xr zip_file_replace 3
مالکیت منبع ارسال‌شده را بر عهده می‌گیرند (پس از اتمام استفاده از آن، شمارش ارجاع را کاهش می‌دهند)، بنابراین
.Xr zip_source_free 3
تنها زمانی نیاز به فراخوانی دارد که این توابع خطایی را برگردانند.
داده‌های زیرین (پرونده یا بافر) باید تا زمان بسته شدن آرشیو معتبر باقی بمانند.
از
.Xr zip_source_keep 3
برای افزایش شمارش ارجاع استفاده کنید، به عنوان مثال اگر پس از
.Xr zip_close 3
به منبع نیاز دارید.
.Sh "همچنین ببینید (SEE ALSO)"
.Xr libzip 3 ,
.Xr zip_source_buffer 3 ,
.Xr zip_source_file 3 ,
.Xr zip_source_filep 3 ,
.Xr zip_source_free 3 ,
.Xr zip_source_function 3 ,
.Xr zip_source_keep 3 ,
.Xr zip_source_window 3 ,
.Xr zip_source_zip 3
.Sh "نویسندگان (AUTHORS)"
.An -nosplit
.An Dieter Baron Aq Mt dillo@nih.at
و
.An Thomas Klausner Aq Mt wiz@gatalith.at